Options
All
  • Public
  • Public/Protected
  • All
Menu

zent

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

$FieldSetBuilderChildren

$FieldSetBuilderChildren<ChildBuilders>: {}

Type parameters

Type declaration

$FieldSetBuilderDefaultValue

$FieldSetBuilderDefaultValue<ChildBuilders>: Partial<$FieldSetValue<$FieldSetBuilderChildren<ChildBuilders>>>

Type parameters

$FieldSetValue

$FieldSetValue<Children>: {}

Type parameters

Type declaration

$GetBuilderModel

$GetBuilderModel<T>: T extends BasicBuilder<infer _, infer M> ? M : never

Type parameters

  • T

$GetBuilderValue

$GetBuilderValue<T>: T extends BasicBuilder<infer V, infer _> ? V : never

Type parameters

  • T

$MergeParams

$MergeParams<T>: (T extends any ? (t: T) => void : never) extends (t: infer V) => void ? V : never

Type parameters

  • T

$MergeProps

$MergeProps<T>: (T extends any ? (t: T) => void : never) extends (r: infer R) => void ? R : never

Type parameters

  • T

ActionButtonClickHandler

ActionButtonClickHandler: (e?: () => void) => Promise<any> | boolean | void

Type declaration

    • (e?: () => void): Promise<any> | boolean | void
    • Parameters

      • Optional e: () => void
          • (): void
          • Returns void

      Returns Promise<any> | boolean | void

AlertTypes

AlertTypes: "info" | "success" | "warning" | "error" | "hint"

CascaderItemSelectionState

CascaderItemSelectionState: "on" | "off" | "partial"

CascaderMenuClickHandler

CascaderMenuClickHandler: (node: ICascaderItem, closePopup: () => void) => void

Type declaration

    • Parameters

      • node: ICascaderItem
      • closePopup: () => void
          • (): void
          • Returns void

      Returns void

CascaderMenuHoverHandler

CascaderMenuHoverHandler: (node: ICascaderItem) => void

Type declaration

CascaderSearchClickHandler

CascaderSearchClickHandler: (path: ICascaderItem[], closePopup: () => void) => void

Type declaration

    • Parameters

      • path: ICascaderItem[]
      • closePopup: () => void
          • (): void
          • Returns void

      Returns void

CascaderTabsClickHandler

CascaderTabsClickHandler: (node: ICascaderItem, closePopup: () => void) => void

Type declaration

    • Parameters

      • node: ICascaderItem
      • closePopup: () => void
          • (): void
          • Returns void

      Returns void

CascaderValue

CascaderValue: string | number

ColorFormats

ColorFormats: "rgb" | "prgb" | "hex" | "hex3" | "hex4" | "hex6" | "hex8" | "name" | "hsl" | "hsv"

ColorInput

ColorInput: string | IRGB | IRGBA | IHSL | IHSLA | IHSV | IHSVA | TinyColor

ColorPickerType

ColorPickerType: "default" | "simple"

CompareOperation

ContainerChild

ContainerChild: ReactElement<INoticeWrapProps, typeof NoticeWrap>

DateNullTuple

DateNullTuple: []

DateRangeQuickPickerChangeCallback

DateRangeQuickPickerChangeCallback: (value: RangeDate, choosePresetValue?: DateRangeQuickPickerPresetValue) => void

Type declaration

DateRangeQuickPickerPresetValue

DateRangeQuickPickerPresetValue: number | RangeDate

DateRangeQuickPickerValueType

DateRangeQuickPickerValueType: "string" | "number" | "date"

DateTuple

DateTuple: []

DrawerContentProps

DrawerPlacement

DrawerPlacement: "left" | "right" | "top" | "bottom"

DrawerProps

ElementType

ElementType: HTMLInputElement | HTMLTextAreaElement

EqualityFn

EqualityFn: (newArgs: unknown[], lastArgs: unknown[]) => boolean

Type declaration

    • (newArgs: unknown[], lastArgs: unknown[]): boolean
    • Parameters

      • newArgs: unknown[]
      • lastArgs: unknown[]

      Returns boolean

EventsMap

EventsMap<E>: Record<E, IEventHandlers>

Type parameters

  • E: string

FechaDays

FechaDays: []

Parse or format dates

FechaFormatFlagHandler

FechaFormatFlagHandler: (dateObj: Date, i18n: IFechaI18nSettings) => string

Type declaration

FechaFormatToken

FechaFormatToken: "D" | "DD" | "Do" | "d" | "dd" | "ddd" | "dddd" | "M" | "MM" | "MMM" | "MMMM" | "YY" | "YYYY" | "h" | "hh" | "H" | "HH" | "m" | "mm" | "s" | "ss" | "S" | "SS" | "SSS" | "a" | "A" | "ZZ"

FechaMonths

FechaMonths: []

FechaParseFlagHandler

FechaParseFlagHandler: []

FindMentionAtCaretPositionReturn

FindMentionAtCaretPositionReturn: { code: 1 } | { caretMeasureStart: number; code: 2; placeholderEnd: number; placeholderStart: number; searchEnd: number; searchStart: number }

FormWarningTag

FormWarningTag: "FieldArray" | "FieldSet" | "Form"

Func

Func<Args, R>: (...args: Args) => R

Type parameters

  • Args: any[]

  • R

Type declaration

    • (...args: Args): R
    • Parameters

      • Rest ...args: Args

      Returns R

GridColumnContextType

GridColumnContextType: Partial<IGridColumn>

GridFixedType

GridFixedType: "left" | "right" | true

GridPaginationType

GridPaginationType: "default" | "lite" | "mini"

GridRowClassNameType

GridRowClassNameType<Data>: string | ((data: Data, rowIndex: number) => string)

Type parameters

  • Data

GridScrollPosition

GridScrollPosition: "both" | "left" | "right" | "middle"

GridSortType

GridSortType: "desc" | "asc" | ""

GridTextAlign

GridTextAlign: "left" | "right" | "center"

I18nLocaleTimePicker

I18nLocaleTimePicker: () => II18nLocaleTimePicker

Type declaration

IAlertItemProps

IAlertItemProps: Omit<IAlertProps, "outline" | "closed"> & { classItemName?: string; onAlertItemClose?: () => void }

Optional closable

closable: boolean

Optional closeContent

closeContent: React.ReactNode

Optional description

description: React.ReactNode

Optional extraContent

extraContent: React.ReactNode

Optional onClose

onClose: () => void

Type declaration

    • (): void
    • Returns void

Optional title

title: React.ReactNode

IAlertRenderRequiredProps

IAlertRenderRequiredProps: PartialRequired<IAlertRenderProps, "outline" | "closed" | "onClose">

IAlertRequiredProps

IAlertRequiredProps: PartialRequired<IAlertProps, "type" | "loading" | "outline" | "closable">

IAutoCompleteMenuItem

IAutoCompleteMenuItem: string | number | IAutoCompleteMenuObjectItem

IButtonHtmlType

IButtonHtmlType: "button" | "submit" | "reset"

IButtonSize

IButtonSize: "medium" | "large" | "small"

IButtonType

IButtonType: "default" | "primary" | "secondary" | "danger" | "warning" | "error" | "success"

ICollapseProps

ICombinedFormTimeRangePickerFieldProps

ICombinedFormTimeRangePickerFieldProps: IFormComponentProps<RangeTime, Omit<ICombinedTimeRangePickerProps, "value">>

ICombinedPropsWithDefault

ICombinedPropsWithDefault: PartialRequired<ICombinedProps, "format" | "valueType" | "placeholder" | "disabledDate">

ICombinedTimeRangePickerPropsWithDefault

ICombinedTimeRangePickerPropsWithDefault: PartialRequired<ICombinedTimeRangePickerProps, "format" | "placeholder">

IComputedProps

IComputedProps: { leftProps: ISliderChildCommonProps; range: true; rightProps: ISliderChildCommonProps; trackStyle: CSSProperties } | { props: ISliderChildCommonProps; range: false; trackStyle: CSSProperties }

IDisabledDate

IDisabledDateFunc

IDisabledDateFunc: (date: Date) => boolean

Type declaration

    • (date: Date): boolean
    • Parameters

      • date: Date

      Returns boolean

IDisabledTime

IDisabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption

Type declaration

IFieldValidProps

Type parameters

  • T

IFieldValueProps

Type parameters

  • T

IFormCheckboxFieldProps

IFormCheckboxFieldProps<Value>: IFormComponentProps<boolean, Omit<ICheckboxProps<Value>, "checked">>

Type parameters

  • Value

IFormCheckboxGroupFieldProps

IFormCheckboxGroupFieldProps<T>: IFormComponentProps<T[], Omit<ICheckboxGroupProps<T>, "value">> & { children?: React.ReactNode }

Type parameters

  • T

IFormColorPickerFieldProps

IFormColorPickerFieldProps: IFormComponentProps<string, Omit<IColorPickerProps, "color">>

IFormCombinedDateRangePickerFieldProps

IFormCombinedDateRangePickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<ICombinedDateRangePickerProps<T>, "value">>

Type parameters

IFormComponentProps

IFormComponentProps<Value, Props, OmitKeys>: {} & { props?: Partial<Props> } & ({} & {}) | ({} & {})

Type parameters

IFormDatePickerField

IFormDatePickerField<T>: IFormComponentProps<SingleDate, Omit<IDatePickerProps<T>, "value">>

Type parameters

IFormDateRangePickerFieldProps

IFormDateRangePickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IDateRangePickerProps<T>, "value">>

Type parameters

IFormDateRangeQuickPickerFieldProps

IFormDateRangeQuickPickerFieldProps: IFormComponentProps<RangeDate, Omit<IDateRangeQuickPickerProps, "value">>

IFormFieldModelProps

IFormFieldModelProps<T>: IFormFieldViewDrivenProps<T> | IFormFieldModelDrivenProps<T>

Type parameters

  • T

IFormFieldProps

IFormFieldProps<Value>: IFormFieldPropsBase<Value> & IFormFieldModelProps<Value> & { children: any }

Type parameters

  • Value

IFormImageUploadFieldProps

IFormImageUploadFieldProps<T>: IFormComponentProps<T[], Omit<IImageUploadProps, "fileList" | "onChange" | "defaultFileList">>

Type parameters

IFormInputFieldProps

IFormInputFieldProps: IFormComponentProps<string, Omit<IInputCoreProps, "value" | "name" | "defaultValue"> | Omit<ITextAreaProps, "value" | "name" | "defaultValue">>

Omit<IInputProps, ...>无法得到正确的类型提示,因此每个类型单独Omit一次再联合

IFormMonthPickerFieldProps

IFormMonthPickerFieldProps<T>: IFormComponentProps<SingleDate, Omit<IMonthPickerProps<T>, "value">>

Type parameters

IFormNumberInputFieldProps

IFormNumberInputFieldProps<T>: IFormComponentProps<T, Omit<INumberInputDecimalProps, "value"> | Omit<INumberInputIntegerProps, "value">>

Type parameters

  • T

IFormQuarterPickerFieldProps

IFormQuarterPickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IQuarterPickerProps<T>, "value">>

Type parameters

IFormRadioGroupFieldProps

IFormRadioGroupFieldProps<T>: IFormComponentProps<T | null, Omit<IRadioGroupProps<T>, "value">> & { children?: React.ReactNode }

Type parameters

  • T

IFormSelectFieldProps

IFormSelectFieldProps<Key, T>: IFormComponentProps<T[], Omit<ISelectProps<Key, T>, "value" | "onChange">>

Type parameters

IFormSingleUploadFieldProps

IFormSingleUploadFieldProps<T>: IFormComponentProps<T | null, Omit<ISingleUploadProps, "value" | "onChange">>

Type parameters

IFormSwitchFieldProps

IFormSwitchFieldProps: IFormComponentProps<boolean, Omit<ISwitchProps, "checked">>

IFormTimePickerField

IFormTimePickerField: IFormComponentProps<SingleTime, Omit<ITimePickerProps, "value">>

IFormTimeRangePickerFieldProps

IFormTimeRangePickerFieldProps: IFormComponentProps<RangeTime, Omit<ITimeRangePickerProps, "value">>

IFormUploadFieldProps

IFormUploadFieldProps<T>: IFormComponentProps<T[], Omit<IUploadProps, "fileList" | "onChange" | "defaultFileList">>

Type parameters

IFormWeekPickerFieldProps

IFormWeekPickerFieldProps<T>: IFormComponentProps<RangeDate, Omit<IWeekPickerProps<T>, "value">>

Type parameters

IFormYearPickerFieldProps

IFormYearPickerFieldProps<T>: IFormComponentProps<SingleDate, Omit<IYearPickerProps<T>, "value">>

Type parameters

IGridBatchRender

IGridBatchRender: (data: any, position?: "header" | "foot") => React.ReactNode

Type declaration

    • (data: any, position?: "header" | "foot"): React.ReactNode
    • Parameters

      • data: any
      • Optional position: "header" | "foot"

      Returns React.ReactNode

IGridColumnBodyRenderFunc

IGridColumnBodyRenderFunc<Data>: (data: Data, pos: IGridCellPos, name?: string) => React.ReactNode

Type parameters

  • Data

Type declaration

    • (data: Data, pos: IGridCellPos, name?: string): React.ReactNode
    • Parameters

      Returns React.ReactNode

IGridInnerFixedType

IGridInnerFixedType: Exclude<GridFixedType, true>

IGridOnExpandHandler

IGridOnExpandHandler<Data>: (data: { data: Data; event: MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }) => any

Type parameters

  • Data

Type declaration

    • (data: { data: Data; event: MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }): any
    • Parameters

      • data: { data: Data; event: MouseEvent<HTMLSpanElement>; expanded: boolean; index: number }
        • data: Data
        • event: MouseEvent<HTMLSpanElement>
        • expanded: boolean
        • index: number

      Returns any

IGridRowClickHandler

IGridRowClickHandler<Data>: (data: Data, index: number, event: MouseEvent<HTMLTableRowElement>) => any

Type parameters

  • Data

Type declaration

    • (data: Data, index: number, event: MouseEvent<HTMLTableRowElement>): any
    • Parameters

      • data: Data
      • index: number
      • event: MouseEvent<HTMLTableRowElement>

      Returns any

IImageOnUploadSuccessReturn

IImageOnUploadSuccessReturn: undefined | null | string | { src: string; thumbSrc: string }

IImageUploadItemProps

IImageUploadItemProps: IUploadItemProps<IImageUploadFileItem> & { onPreview: (file: IImageUploadFileItem) => void }

IImageUploadPreviewHandler

IImageUploadPreviewHandler: (file: IImageUploadFileItem, fileList: IImageUploadFileItem[]) => void

Type declaration

IImageUploadPropsInner

IImageUploadPropsInner: PartialRequired<IImageUploadProps, "maxAmount" | "maxSize" | "multiple" | "getThumbSrcFromFile" | "preview" | "accept" | "manualUpload">

IInputChangeEvent

IInputChangeEvent: IInputClearEvent | ChangeEvent<HTMLInputElement>

IInputProps

IMaybeError

IMaybeError<T>: IValidateResult<T> | null | undefined

Type parameters

  • T

IMenuCascaderProps

IMenuContentProps

IMenuProps

INormalUploadItemProps

INormalUploadItemProps: IUploadItemProps<IUploadFileItem>

INumberInputProps

INumberInputState

IPickerType

IPickerType: "date" | "week" | "month" | "quarter" | "year"

IPopActionCallback

IPopActionCallback: (() => Promise<void>) | ((close: () => void) => void)

IPopProps

IProgressFormatFn

IProgressFormatFn: (precent: number) => React.ReactNode

Type declaration

    • (precent: number): React.ReactNode
    • Parameters

      • precent: number

      Returns React.ReactNode

IProgressStatus

IProgressStatus: "normal" | "success" | "exception"

IProgressType

IProgressType: "line" | "circle"

IRangeDisabledDateFunc

IRangeDisabledDateFunc: (date: Date, type?: RangeType) => boolean

Type declaration

    • Parameters

      Returns boolean

IRangePropsWithDefault

IRangePropsWithDefault: PartialRequired<IRangeProps, "format" | "valueType" | "placeholder" | "disabledDate">

IScrollAlertInnerProps

IScrollAlertInnerProps: PartialRequired<IScrollAlertProps, "loading" | "scrollInterval" | "onClose" | "closed">

ISelectProps

ISelectProps<Key, Item>: ISelectMultiProps<Key, Item> | ISelectSingleProps<Key, Item>

Type parameters

IShowTime

IShowTime<T>: boolean | IShowTimeOption<T>

Type parameters

  • T

IShowTimeOptionWithDefault

IShowTimeOptionWithDefault: PartialRequired<IShowTimeOption<string>, "format" | "defaultTime">

IShowTimeRange

IShowTimeRange<T>: boolean | IShowTimeRangeOption<T>

Type parameters

  • T

ISingleDateBodyProps

ISingleDateBodyProps: Omit<ISinglePanelProps, "onChangePanel">

ISinglePropsWithDefault

ISinglePropsWithDefault: PartialRequired<ISingleProps, "format" | "valueType" | "placeholder" | "disabledDate">

ISingleTimePickerPropsWithDefault

ISingleTimePickerPropsWithDefault: PartialRequired<ISingleTimePickerProps, "format" | "placeholder">

ISingleUploadItemProps

ISingleUploadItemProps: IUploadItemProps<IUploadFileItem>

ISingleUploadPropsInner

ISingleUploadPropsInner: PartialRequired<ISingleUploadProps, "maxSize" | "manualUpload">

ISliderProps

ITabOverflowMode

ITabOverflowMode: "slide" | "anchor"

ITabPanelElement

ITabPanelElement<TabPanelProps>: ReactElement<PropsWithChildren<TabPanelProps>>

Type parameters

  • TabPanelProps

ITabsInnerProps

ITabsInnerProps<Id>: Required<ITabsProps<Id>>

Type parameters

  • Id: string | number

ITimeRangePickerPropsWithDefault

ITimeRangePickerPropsWithDefault: PartialRequired<ITimeRangePickerProps, "format" | "placeholder">

ITimeUnitType

ITimeUnitType: "hour" | "minute" | "second"

ITooltipProps

ITriggerDivProps

ITriggerDivProps: Pick<ISingleTriggerProps, "disabled" | "canClear" | "panelVisible" | "width">

IUnitType

IUnitType: "hour" | "minute" | "second"

IUploadFileItemInner

IUploadFileItemInner<UPLOAD_ITEM>: UPLOAD_ITEM & { _file?: File; _id?: string }

Type parameters

IUploadOnChangeHandler

IUploadOnChangeHandler<Value, UPLOAD_ITEM>: (value: Value, detail?: IUploadChangeDetail<UPLOAD_ITEM>) => void

Type parameters

Type declaration

IUploadOnErrorHandler

IUploadOnErrorHandler: <Type>(type: Type, data: IUploadErrorMessageConfigMap[Type]) => void

Type declaration

    • <Type>(type: Type, data: IUploadErrorMessageConfigMap[Type]): void

IUploadOnUploadHandler

IUploadOnUploadHandler<ON_UPLOAD_SUCCESS_RETURN>: (file: File, report: (percent: number) => void) => Promise<ON_UPLOAD_SUCCESS_RETURN>

Type parameters

  • ON_UPLOAD_SUCCESS_RETURN

Type declaration

    • (file: File, report: (percent: number) => void): Promise<ON_UPLOAD_SUCCESS_RETURN>
    • Parameters

      • file: File
      • report: (percent: number) => void
          • (percent: number): void
          • Parameters

            • percent: number

            Returns void

      Returns Promise<ON_UPLOAD_SUCCESS_RETURN>

IUploadPropsInner

IUploadPropsInner: PartialRequired<IUploadProps, "maxAmount" | "maxSize" | "multiple" | "pagination" | "pageSize" | "manualUpload">

IUploadTipConfig

IUploadTipConfig<P>: P & { formattedMaxSize: string | null }

Type parameters

  • P

IUploadTipsFunc

IUploadTipsFunc<PROPS>: (config: IUploadTipConfig<PROPS>) => React.ReactNode

Type parameters

  • PROPS

Type declaration

IUseFieldArray

IUseFieldArray<Item, Child>: []

Type parameters

IUseFieldSet

IUseFieldSet<T>: []

Type parameters

IValidator

IValidator<T>: IAsyncValidator<T> | ISyncValidator<T>

Type parameters

  • T

IValidators

IValidators<T>: keyof IValidator<T>[]

Type parameters

  • T

IValueType

IValueType: "date" | "number" | "string"

IVerticalInnerTab

IVerticalInnerTab<Id>: IInnerTab<Id> | IVerticalDivide

Type parameters

  • Id

IVerticalTab

IVerticalTab<Id>: ITab<Id> | IVerticalDivide

Type parameters

  • Id

IVerticalTabPanelProps

IVerticalTabPanelProps<Id>: ITabPanelProps<Id> | IVerticalDivide

Type parameters

  • Id

IconType

IconType: "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "drag" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left" | "left-circle" | "left-circle-o" | "link" | "lock" | "marketing" | "member-o" | "message" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video" | "video-guide-o" | "visit-o" | "voice" | "warning" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"

InputType

InputType: "text" | "number" | "password" | "textarea"

LayoutBreakPointMap

LayoutBreakPointMap: Record<LayoutBreakPoint, LayoutBreakPointName>

LayoutBreakPointName

LayoutBreakPointName: keyof typeof LayoutBreakPoint

ListIterator

ListIterator<T, TResult>: (value: T, index: number, collection: ArrayLike<T>) => TResult

Type parameters

  • T

  • TResult

Type declaration

    • (value: T, index: number, collection: ArrayLike<T>): TResult
    • Parameters

      • value: T
      • index: number
      • collection: ArrayLike<T>

      Returns TResult

ListPropsType

ListPropsType: typeof ListProps[number]

ListType

ListType: { columns: TransferColumnType; selection?: { getCheckboxProps: (data: ITransferData) => { disabled?: boolean; reason?: React.ReactNode } } } & Pick<IGridProps<ITransferData>, ListPropsType>

LoadingColorPreset

LoadingColorPreset: "primary" | "grey"

LoadingTextPosition

LoadingTextPosition: "top" | "bottom" | "left" | "right"

Maybe

Maybe<T>: ISome<T> | null | undefined

Type parameters

  • T

Middleware

Middleware<F>: (next: F) => F

Type parameters

  • F

Type declaration

    • (next: F): F
    • Parameters

      • next: F

      Returns F

NoticePositions

NoticePositions: "right-top" | "right-bottom" | "left-top" | "left-bottom"

ObjectKey

ObjectKey: string | number

This is a modified version from underscore. https://github.com/jashkenas/underscore/blob/master/underscore.js

With some differences:

  • It's iterative
  • Bug fixes regarding NaN, 0 and -0 values
  • Throws on unsupported value types, such as Map/Set/WeakMap/WeakSet

OneRequired

OneRequired: { children?: (props: ITransferChildrenProps) => React.ReactNode; list: ListType | [] } | { children: (props: ITransferChildrenProps) => React.ReactNode; list?: ListType | [] }

PaginationChangeHandler

PaginationChangeHandler: (detail: { current: number; pageSize: number }) => any

Type declaration

    • (detail: { current: number; pageSize: number }): any
    • Parameters

      • detail: { current: number; pageSize: number }
        • current: number
        • pageSize: number

      Returns any

PaginationLayout

PaginationLayout: { disabled: boolean; type: "left-arrow" } | { disabled: boolean; type: "right-arrow" } | { page: number; selected: boolean; type: "number" } | { type: "double-left-arrow" } | { type: "double-right-arrow" } | { totalPages: number; type: "mini-jumper" }

PaginationLayoutFunction

PaginationLayoutFunction: (options: IPaginationLayoutOptions) => PaginationLayout[]

Type declaration

PaginationPageSizeOption

PaginationPageSizeOption: number | IPaginationPageSizeCompoundOption

PartialRequired

PartialRequired<T, K>: Omit<T, K> & Required<Pick<T, K>>

Type parameters

  • T

  • K: keyof T

PassDownGridPropsType

PassDownGridPropsType: typeof PassDownGridProps[number]

PointId

PointId: "point-left" | "point-right" | "point-single"

PopPositions

PopPositions: "left-top" | "left-center" | "left-bottom" | "right-top" | "right-center" | "right-bottom" | "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | "auto-bottom-center" | "auto-bottom-left" | "auto-bottom-right" | "auto-top-center" | "auto-top-left" | "auto-top-right"

PopoverAnchorGetElementFn

PopoverAnchorGetElementFn: (node: Element | Text | null) => Element | Text | null

Type declaration

    • (node: Element | Text | null): Element | Text | null
    • Parameters

      • node: Element | Text | null

      Returns Element | Text | null

PresetColors

PresetColors: string[]

RangeDate

RangeDate: []

RangeTime

RangeTime: []

RangeType

RangeType: "start" | "end"

SingleDate

SingleDate: string | number | Date

SingleTime

SingleTime: string

SketchPresetColorValue

SketchPresetColorValue: string | { hex: string; source: string }

StringTuple

StringTuple: []

TArray

TArray<T>: T[]

Type parameters

  • T

TabType

TabType: "normal" | "card" | "button"

TextMarkFindChunksFunction

TextMarkFindChunksFunction: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]

Type declaration

TextMarkSanitizeFunction

TextMarkSanitizeFunction: (str: string) => string

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

TextMarkSearchWords

TextMarkSearchWords: string | RegExp

TimerId

TimerId: ReturnType<typeof setTimeout> | undefined | null

TransferColumnType

TransferColumnType: Array<{ name: string; title?: React.ReactNode } & Omit<IGridColumn<ITransferData>, "title" | "name">>

TransferDirection

TransferDirection: "left" | "right"

TransferType

TransferType: OneRequired & ITransfer

TreeRootIdArray

TreeRootIdArray: TArray<string | number>

UnknownFieldSetBuilderChildren

UnknownFieldSetBuilderChildren: Record<string, BasicBuilder<any, BasicModel<any>>>

UnknownFieldSetModelChildren

UnknownFieldSetModelChildren: Record<string, BasicModel<any>>

UnknownObject

UnknownObject: Record<string, unknown>

Variables

Const ANIMATION_DELAY

ANIMATION_DELAY: 1000 = 1000

Const ANIMATION_DURATION

ANIMATION_DURATION: 400 = 400

Const ASYNC_VALIDATOR

ASYNC_VALIDATOR: unique symbol = Symbol('AsyncValidator')

Const Affix

Affix: ForwardRefExoticComponent<IAffixProps & RefAttributes<IAffixImperativeHandlers>> = forwardRef<IAffixImperativeHandlers, IAffixProps>(({className,placeholderClassName,children,offsetTop,offsetBottom,getAffixContainer,zIndex = 10,onPin,onUnpin,},affixRef) => {const [position, setPosition] = useState(WaypointPosition.Inside);const [width, setWidth] = useState<number>();const [height, setHeight] = useState<number>();const placeholderRef = useRef(createRef<HTMLDivElement>());const onPinCallbackRef = useCallbackRef(onPin);const onUnpinCallbackRef = useCallbackRef(onUnpin);const useTop = typeof offsetTop === 'number';const useBottom = typeof offsetBottom === 'number';const [container, setContainer] = useState<HTMLElement>(null);const [containerTop, setContainerTop] = useState(0);const [containerBottom, setContainerBottom] = useState(0);const [windowHeight, setWindowHeight] = useState(0);const containerBoundingRectChange = useCallback((container: HTMLElement) => {const rect = container.getBoundingClientRect();useTop && setContainerTop(rect.top);useBottom && setContainerBottom(rect.bottom);},[useTop, useBottom]);const setSize = useCallback((entries: ResizeObserverEntry[]) => {const { borderBoxSize, contentRect } = entries[0];if (borderBoxSize && borderBoxSize.length > 0) {const [{ inlineSize: width, blockSize: height }] = borderBoxSize;setWidth(width);setHeight(height);} else {const { width, height } = contentRect;setWidth(width);setHeight(height);}}, []);const { observe, disconnect } = useResizeObserver(setSize);const pin = useCallback((expectedPosition: WaypointPosition) => ({currentPosition,}: IWaypointCallbackData) => {if (currentPosition !== expectedPosition) {return;}const node = placeholderRef.current?.current;if (node) {setWidth(node.offsetWidth);setHeight(node.offsetHeight);}observe(node);setPosition(currentPosition);onPinCallbackRef.current?.();},[onPinCallbackRef, observe]);const unpin = useCallback((expectedPrevPosition: WaypointPosition) => ({currentPosition,previousPosition,}: IWaypointCallbackData) => {if (previousPosition !== expectedPrevPosition) {return;}setWidth(undefined);setHeight(undefined);disconnect();setPosition(currentPosition);onUnpinCallbackRef.current?.();},[onUnpinCallbackRef, disconnect]);const [pinTop, unpinTop] = useMemo(() => [pin(WaypointPosition.Above), unpin(WaypointPosition.Above)],[pin, unpin]);const [pinBottom, unpinBottom] = useMemo(() => [pin(WaypointPosition.Below), unpin(WaypointPosition.Below)],[pin, unpin]);const placeholderStyle = useMemo<React.CSSProperties>(() => {if (position === WaypointPosition.Inside) {return {};}return {height,};}, [height, position]);const containerStyle = useMemo<React.CSSProperties>(() => {if (position === WaypointPosition.Above ||position === WaypointPosition.Below) {const styles: React.CSSProperties = {position: 'fixed',zIndex,width,};if (container) {if (position === WaypointPosition.Above) {styles.top = offsetTop + containerTop;} else {styles.bottom = offsetBottom + (windowHeight - containerBottom);}} else {if (position === WaypointPosition.Above) {styles.top = offsetTop;} else {styles.bottom = offsetBottom;}}return styles;}return { position: 'static' };}, [container,offsetBottom,offsetTop,containerTop,containerBottom,windowHeight,position,width,zIndex,]);const updatePosition = useCallback(() => {container && containerBoundingRectChange(container);}, [container, containerBoundingRectChange]);// init containeruseEffect(() => {const containerNode = getAffixContainer?.();if (containerNode) {setContainer(containerNode);containerBoundingRectChange(containerNode);setWindowHeight(getViewportHeight());}}, [getAffixContainer, containerBoundingRectChange]);const onWindowResize = useCallback(() => {setWindowHeight(getViewportHeight());}, []);useImperativeHandle(affixRef, () => ({updatePosition,}));const ancestor = useMemo(() => {return container ?? (isBrowser ? window : undefined);}, [container]);return (<>{useTop && (<WaypointscrollableAncestor={ancestor}onEnter={unpinTop}onLeave={pinTop}topOffset={offsetTop}/>)}<divclassName={cx('zent-affix-placeholder', placeholderClassName)}style={placeholderStyle}ref={placeholderRef.current}><div className={cx('zent-affix', className)} style={containerStyle}>{children}</div></div>{useBottom && (<WaypointscrollableAncestor={ancestor}onEnter={unpinBottom}onLeave={pinBottom}bottomOffset={offsetBottom}/>)}{container && (<WindowResizeHandler onResize={onWindowResize} disableThrottle />)}</>);})

Const ArrowOffsetHorizontal

ArrowOffsetHorizontal: number = __ARROW_OFFSET_HORIZONTAL__

Exported compiler constants for use in @zent/compat

Const ArrowOffsetVertical

ArrowOffsetVertical: number = __ARROW_OFFSET_VERTICAL__

Const BREAKPOINTS

BREAKPOINTS: LayoutBreakPoint[] = Object.keys(BREAKPOINT_MAP) as LayoutBreakPoint[]

Const BREAKPOINT_MAP

BREAKPOINT_MAP: {} = (Object.keys(LayoutBreakPoint) as LayoutBreakPointName[]).reduce((m, k) => {m[LayoutBreakPoint[k]] = k;return m;}, {} as LayoutBreakPointMap)

Type declaration

Const BTN_WIDTH

BTN_WIDTH: 28 = 28

Const CJK_REGEXP

CJK_REGEXP: RegExp = /\xB7|\xD7|\u2014|\u2018|\u2019|\u201C|\u201D|\u2026|[\u2E80-\u2EFF]|[\u3000-\u303F]|[\u3040-\u309F]|[\u30A0-\u30FF]|[\u31C0-\u31EF]|[\u3200-\u32FF]|[\uFF00-\uFFEF]|[\u4E00-\u9FFF]|[\u3400-\u4DBF]|(?:[\uD840-\uD868][\uDC00-\uDFFF]|\uD869[\uDC00-\uDEDF])|(?:\uD869[\uDF00-\uDFFF]|[\uD86A-\uD86C][\uDC00-\uDFFF]|\uD86D[\uDC00-\uDF3F])|(?:\uD86D[\uDF40-\uDFFF]|\uD86E[\uDC00-\uDC1F])|(?:\uD86E[\uDC20-\uDFFF]|[\uD86F-\uD872][\uDC00-\uDFFF]|\uD873[\uDC00-\uDEAF])|(?:\uD873[\uDEB0-\uDFFF]|[\uD874-\uD879][\uDC00-\uDFFF]|\uD87A[\uDC00-\uDFEF])|(?:[\uD880-\uD883][\uDC00-\uDFFF]|\uD884[\uDC00-\uDF4F])|[\uF900-\uFAFF]|[\u3300-\u33FF]|[\uFE30-\uFE4F]|[\uF900-\uFAFF]|(?:\uD87E[\uDC00-\uDE1F])/

Const COL_COUNT

COL_COUNT: 2 = 2

Const COMBINED_INPUT_WIDTH

COMBINED_INPUT_WIDTH: 360 = 360

Const CSS_INTEGER

CSS_INTEGER: "[-\+]?\d+%?" = "[-\+]?\d+%?"

Const CSS_NUMBER

CSS_NUMBER: "[-\+]?\d*\.\d+%?" = "[-\+]?\d*\.\d+%?"

Const CSS_UNIT

CSS_UNIT: string = `(?:${CSS_NUMBER})|(?:${CSS_INTEGER})`

Const ColorBoard

ColorBoard: ComponentClass<any, any> = ColorWrap(Sketch)

Const ContentContext

ContentContext: Context<IPopoverContentContext> = createContext<IPopoverContentContext>({positionChanged$: new Subject(),})

Const DATE_FORMAT

DATE_FORMAT: "YYYY-MM-DD" = "YYYY-MM-DD"

Const DEFAULT_ENABLE_MULTIPLE

DEFAULT_ENABLE_MULTIPLE: false = false

Const DEFAULT_HEIGHT

DEFAULT_HEIGHT: 23 = 23

Const DEFAULT_LOADER

DEFAULT_LOADER: Element = <BlockLoading height={60} loading icon="circle" />

Const DEFAULT_LOADING

DEFAULT_LOADING: Element = (<div className="zent-select-v2-popup-loading"><BlockLoadingloadingicon="circle"height={96}iconSize={24}iconText="加载中"/></div>)

Const DEFAULT_MAX_AMOUNT

DEFAULT_MAX_AMOUNT: number = Infinity

Const DEFAULT_MAX_SIZE

DEFAULT_MAX_SIZE: number = Infinity

Const DEFAULT_SEGMENTS

DEFAULT_SEGMENTS: number[][] = [[61.8, 38],[30, 25, 44],[20, 75],[33, 16, 20, 27],[12, 32, 53],[45, 12, 42],[20, 10, 47, 18],[14, 47, 37],]

Const DEFAULT_SIZE

DEFAULT_SIZE: 24 = 24

Const DEFAULT_TRANSITION

DEFAULT_TRANSITION: {}

Type declaration

Const DEFAULT_VALUE

DEFAULT_VALUE: any[] = [] as any[]

Const DefaultEndTime

DefaultEndTime: string = formatEndDate(TIME_FORMAT)

Const DefaultStartTime

DefaultStartTime: string = formatStartDate(TIME_FORMAT)

Const DisabledContext

DisabledContext: Context<IDisabledContext> = createContext<IDisabledContext>({value: false,})

Const DropdownClickTrigger

DropdownClickTrigger: PopoverClickTrigger = PopoverClickTrigger

Const DropdownContent

DropdownContent: PopoverContent = PopoverContent

Const DropdownContext

DropdownContext: Context<boolean> = createContext<boolean>(false)

Const DropdownHoverTrigger

DropdownHoverTrigger: PopoverHoverTrigger = PopoverHoverTrigger

Const DropdownPosition

DropdownPosition: "/home/runner/work/zent/zent/packages/zent/src/popover/placement/index" = Popover.Position

Const EASE_IN

EASE_IN: "cubic-bezier(0.17, 0.84, 0.44, 0.1)" = "cubic-bezier(0.17, 0.84, 0.44, 0.1)"

Const EASE_IN_OUT

EASE_IN_OUT: "cubic-bezier(0.5, 0, 0.5, 0.1)" = "cubic-bezier(0.5, 0, 0.5, 0.1)"

Const EASE_OUT

EASE_OUT: "cubic-bezier(0.18, 0.66, 0.6, 0.82)" = "cubic-bezier(0.18, 0.66, 0.6, 0.82)"

Const EMAIL_REGEXP

EMAIL_REGEXP: RegExp = /^(?=.{1,254}$)(?=.{1,64}@)[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+(\.[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+)*@[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*$/

Const EMOJI_REGEXP

EMOJI_REGEXP: RegExp = /(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe2f\u20d0-\u20ff\u1ab0-\u1aff\u1dc0-\u1dff]|\ud83c[\udffb-\udfff])?(?:\u200d(?:[^\ud800-\udfff]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe2f\u20d0-\u20ff\u1ab0-\u1aff\u1dc0-\u1dff]|\ud83c[\udffb-\udfff])?)*/

Const EMPTY_DECIMAL

EMPTY_DECIMAL: Big = new Decimal(0)

END

END: END

Const FIELD_ARRAY_ID

FIELD_ARRAY_ID: unique symbol = Symbol('field-array')

Const FIELD_ID

FIELD_ID: unique symbol = Symbol('field')

Const FILTER_DEBOUNCE_TIME

FILTER_DEBOUNCE_TIME: 200 = 200

Const FORM_ID

FORM_ID: unique symbol = Symbol('form')

Const FormChildrenContext

FormChildrenContext: Context<IZentFormChildrenContext> = createContext<IZentFormChildrenContext | null>(null)

Const FormContext

FormContext: Context<IZentFormContext> = createContext<IZentFormContext>({})

Const FormContextNotFoundError

FormContextNotFoundError: FormulrError = new FormulrError('FormContext not found',['Using form hooks outside the form context',"There's a copy of formulr in your project, run `yarn list formulr` to check",])

Const FormControl

FormControl: ForwardRefExoticComponent<IFormControlProps & RefAttributes<HTMLDivElement>> = forwardRef<HTMLDivElement, IFormControlProps>(({ className, style, label, children, required, invalid, withoutLabel },ref) => {return (<divref={ref}className={cx('zent-form-control',{'has-error': invalid,},className)}style={style}>{withoutLabel ? null : <Label required={required}>{label}</Label>}<div className="zent-form-control-content">{children}</div></div>);})

Const FormError

FormError: ForwardRefExoticComponent<IFormErrorProps & RefAttributes<HTMLDivElement>> = forwardRef<HTMLDivElement, IFormErrorProps>(({ className, style, children }, ref) => (<divref={ref}className={cx('zent-form-error', 'zent-font-small', className)}style={style}>{children}</div>))

Const FormProvider

FormProvider: ProviderExoticComponent<ProviderProps<IFormContext>> = FormContext.Provider

Const GRADIENT_ID

GRADIENT_ID: string = uniqueId('zentAnimatedArcStrokeGradient')

Const GridColumnContext

GridColumnContext: Context<{}> = createContext<GridColumnContextType>({})

Const GridColumnProvider

GridColumnProvider: ProviderExoticComponent<ProviderProps<{}>> = GridColumnContext.Provider

Const GroupContextProvider

GroupContextProvider: ProviderExoticComponent<ProviderProps<ICheckboxContext<any>>> = GroupContext.Provider

Const IMAGE_DEFAULT_ACCEPT

IMAGE_DEFAULT_ACCEPT: "image/jpeg, image/png, image/bmp, image/gif" = "image/jpeg, image/png, image/bmp, image/gif"

Const IMECompositionContext

IMECompositionContext: Context<IIMECompositionContext> = createContext<IIMECompositionContext>({enable: false,})

Const INPUT_WIDTH

INPUT_WIDTH: 56 = 56

Const Icon

  • Icon(__namedParameters: { icon: string; rest: rest }): Element

Const InfiniteScroller

InfiniteScroller: ForwardRefExoticComponent<IInfiniteScrollerProps & RefAttributes<HTMLDivElement>> = forwardRef<HTMLDivElement,IInfiniteScrollerProps>(({hasMore = false,loadMore,skipLoadOnMount = false,useWindow = false,loader = DEFAULT_LOADER,threshold = 0,className,children,},ref) => {const [loading, setLoading] = useState(false);const mounted = useMounted();const stopLoading = useCallback(() => {if (mounted.current) {setLoading(false);}}, [mounted]);const load = useCallback(() => {if (typeof loadMore !== 'function') {return;}setLoading(true);if (loadMore.length > 0) {loadMore(stopLoading);} else {(loadMore as () => Promise<unknown>)().then(stopLoading, stopLoading);}}, [loadMore, stopLoading]);const onEnter = useCallback((data: IWaypointCallbackData) => {if (loading) {return;}const { previousPosition } = data;if (previousPosition === WaypointPosition.Below) {load();}},[load, loading]);// Run once after mountuseEffect(() => {if (!skipLoadOnMount) {load();}// eslint-disable-next-line react-hooks/exhaustive-deps}, []);return (<divclassName={cx(`zent-infinite-scroller`, className, {[`zent-infinite-scroller-y`]: !useWindow,})}ref={ref}>{children}{hasMore && isBrowser && (<WaypointscrollableAncestor={useWindow ? window : undefined}onEnter={onEnter}bottomOffset={-threshold}/>)}{loading && loader}</div>);})

Const InputContext

InputContext: Context<IInputContext> = createContext<IInputContext>({renderInner: null,})

Const InputCore

InputCore: ForwardRefExoticComponent<IInputCoreProps & { onClear: React.MouseEventHandler<HTMLElement> } & RefAttributes<HTMLInputElement>> = forwardRef<HTMLInputElement,IInputCoreProps & { onClear: React.MouseEventHandler<HTMLElement> }>((props, ref) => {const {addonBefore,addonAfter,showClear,value: valueProp,onChange: onChangeProp,onCompositionStart: onCompositionStartProp,onCompositionEnd: onCompositionEndProp,onClear,width,size,onPressEnter,autoFocus,autoSelect,initSelectionStart,initSelectionEnd,icon,inline,onIconClick,...otherProps} = props;const {value,onChange,onCompositionStart,onCompositionEnd,} = useIMEComposition(valueProp,onChangeProp,onCompositionStartProp,onCompositionEndProp);// No clear button when input is disabled or readonlyconst showClearIcon =showClear && valueProp && !otherProps.disabled && !otherProps.readOnly;return (<>{addonBefore && (<div className="zent-input-addon-before">{addonBefore}</div>)}<input{...otherProps}ref={ref}className="zent-input"value={value}onChange={onChange}onCompositionStart={onCompositionStart}onCompositionEnd={onCompositionEnd}/>{showClearIcon && (<IconclassName="zent-input-close"type="close-circle"onClick={onClear}onMouseDown={preventDefault}/>)}{icon ? (<Icon className="zent-input-icon" type={icon} onClick={onIconClick} />) : null}{addonAfter && <div className="zent-input-addon-after">{addonAfter}</div>}</>);})

Const LINEAR

LINEAR: "cubic-bezier(0, 0, 0.1, 0.1)" = "cubic-bezier(0, 0, 0.1, 0.1)"

Const LayoutBreakpointContext

LayoutBreakpointContext: Context<{}> = createContext<Partial<Record<LayoutBreakPoint, boolean>>>({} as Record<LayoutBreakPoint, boolean>)

Const LayoutConfigContext

LayoutConfigContext: Context<ILayoutConfig> = createContext<ILayoutConfig>({rowGutter: 0,colGutter: 0,})

Const LayoutConfigProvider

LayoutConfigProvider: ProviderExoticComponent<ProviderProps<ILayoutConfig>> = LayoutConfigContext.Provider

Const Link

Link: ForwardRefExoticComponent<ILinkProps & RefAttributes<HTMLAnchorElement>> = forwardRef<HTMLAnchorElement, ILinkProps>((props, ref) => {const disabledContext = useContext(DisabledContext);const {className,disabled = disabledContext.value,onClick,...rest} = props;return (<a{...rest}className={cx(className, 'zent-link', {'zent-link__disabled': disabled,})}ref={ref}onClick={disabled ? preventOpenLink : onClick}/>);})

Const ListProps

ListProps: ["selection", "rowKey", "scroll", "emptyLabel", "onRowClick", "sortBy", "sortType", "defaultSortType", "bordered", "ellipsis", "components", "rowProps", "autoStick", "autoStickOffsetTop", "disableHoverHighlight", "onChange", "loading", "className", "rowClassName"] = ['selection', ...PassDownGridProps] as const

Const MAX_PAGE

MAX_PAGE: 96 = 96

Const MAX_PAGES_TO_EXPAND

MAX_PAGES_TO_EXPAND: 5 = 5

Const MAX_YEAR

MAX_YEAR: 3000 = 3000

Const MENTION_FOUND

MENTION_FOUND: 2 = 2

Const MENTION_NOT_FOUND

MENTION_NOT_FOUND: 1 = 1

Const MIN_YEAR

MIN_YEAR: 1840 = 1840

Const MIRROR_DIV_ID

MIRROR_DIV_ID: "zent-input-textarea-caret-coordinates-mirror-div" = "zent-input-textarea-caret-coordinates-mirror-div"

Const MODEL_ID

MODEL_ID: unique symbol = Symbol('model')

Const MONTH_FORMAT

MONTH_FORMAT: "YYYY-MM" = "YYYY-MM"

Const NAV_KEYS

NAV_KEYS: string[] = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight']

Const NO_STYLE

NO_STYLE: CSSProperties

Const NoticeContext

NoticeContext: Context<INoticeContext> = createContext<INoticeContext | null>(null)

Const ONE_DAY

ONE_DAY: number = 1000 * 60 * 60 * 24

Const OmitChildProp

OmitChildProp: ["outline", "closed", "onClose"] = ['outline', 'closed', 'onClose'] as const

Const OmitDivAttr

OmitDivAttr: ["loading", "scrollInterval", "onClose", "closed"] = ['loading', 'scrollInterval', 'onClose', 'closed'] as const

Const PERMISSIVE_MATCH3

PERMISSIVE_MATCH3: string = `[\\s|\\(]+(${CSS_UNIT})[,|\\s]+(${CSS_UNIT})[,|\\s]+(${CSS_UNIT})\\s*\\)?`

Const PERMISSIVE_MATCH4

PERMISSIVE_MATCH4: string = `[\\s|\\(]+(${CSS_UNIT})[,|\\s]+(${CSS_UNIT})[,|\\s]+(${CSS_UNIT})[,|\\s]+(${CSS_UNIT})\\s*\\)?`

Const PREFIX

PREFIX: string = 'v' +__ZENT_VERSION__.replace(/[^0-9a-z]/gi, 'x') +Math.ceil(Math.random() * 8999 + 1000).toString()

Const PanelContextProvider

PanelContextProvider: ProviderExoticComponent<ProviderProps<IPanelContext>> = PanelContext.Provider

Const PassDownGridProps

PassDownGridProps: ["rowKey", "scroll", "emptyLabel", "onRowClick", "sortBy", "sortType", "defaultSortType", "bordered", "ellipsis", "components", "rowProps", "autoStick", "autoStickOffsetTop", "disableHoverHighlight", "onChange", "loading", "className", "rowClassName"] = ['rowKey','scroll','emptyLabel','onRowClick','sortBy','sortType','defaultSortType','bordered','ellipsis','components','rowProps','autoStick','autoStickOffsetTop','disableHoverHighlight','onChange','loading','className','rowClassName',] as const

Const Path

Path: "M10 11l-1 1-4-4-1-1 5-5 1 1-4 4 4 4z" = "M10 11l-1 1-4-4-1-1 5-5 1 1-4 4 4 4z"

Const PickerContext

PickerContext: Context<IPickerContextProps> = createContext<IPickerContextProps>({i18n: TimePicker(),})

Const PickerContextProvider

PickerContextProvider: ProviderExoticComponent<ProviderProps<IPickerContextProps>> = PickerContext.Provider

Const PopoverHoverTriggerContext

PopoverHoverTriggerContext: Context<IPopoverHoverTriggerContext> = createContext<IPopoverHoverTriggerContext>({ fixMouseEventsOnDisabledChildren: false })

Const Portal

Portal: ForwardRefExoticComponent<IPortalProps & RefAttributes<IPortalImperativeHandlers>> = forwardRef<IPortalImperativeHandlers, IPortalProps>((props, ref) => {const {visible = true,layer = 'div',selector = 'body',useLayerForClickAway = false,className,style,blockPageScroll = false,closeOnESC = false,closeOnClickOutside = false,children,append,} = props;// skip render in SSRconst node = useMemo(() => (isBrowser ? createElement(layer) : null), [layer,]);const getParent = useMemo(() => memorize(getNodeFromSelector), []);const propsRef = useRef<IPortalProps>(props);propsRef.current = props;const prevStyleRef = useRef<React.CSSProperties | undefined>(style);const purePortalRef = useRef<PurePortal>(null);useImperativeHandle<IPortalImperativeHandlers, IPortalImperativeHandlers>(ref,() => ({contains(node: Node) {const purePortal = purePortalRef.current;if (!purePortal) {return false;}return purePortal.contains(node);},purePortalRef,container: node,}),[node]);useLayoutEffect(() => {className && (node.className = className);}, [node, className]);useLayoutEffect(() => {const result = diffStyle(prevStyleRef.current || {}, style || {});setValueForStyles(node, result);prevStyleRef.current = style;}, [node, style]);useLayoutEffect(() => {if (!visible || !useLayerForClickAway) {return noop;}const { position, top, bottom, left, right } = node.style;const parent = getParent(selector);node.style.position = parent === document.body ? 'fixed' : 'absolute';node.style.top = '0';node.style.bottom = '0';node.style.left = '0';node.style.right = '0';return () => {node.style.position = position;node.style.top = top;node.style.bottom = bottom;node.style.left = left;node.style.right = right;};}, [node, useLayerForClickAway, visible, selector, getParent]);useLayoutEffect(() => {const parent = getParent(selector);if (!visible ||!blockPageScroll ||!(parent instanceof HTMLElement) ||!hasScrollbarY(parent)) {return noop;}patchElement(parent);return () => restoreElement(parent);}, [selector, visible, blockPageScroll, getParent]);useLayoutEffect(() => {function handler(event: TouchEvent | MouseEvent) {const { closeOnClickOutside, onClose, visible } = propsRef.current;const purePortal = purePortalRef.current;if (event.defaultPrevented ||!closeOnClickOutside ||!visible ||!purePortal) {return;}const { target } = event;if (!(target instanceof Node) ||target === node ||!purePortal.contains(target)) {onClose && onClose(event);}}let dispose = noop;if (closeOnClickOutside) {let cancelTouchStart: () => void;let cancelClick: () => void;if (useLayerForClickAway) {cancelTouchStart = addEventListener(node, 'touchstart', handler);cancelClick = addEventListener(node, 'click', handler);} else {cancelTouchStart = addEventListener(window, 'touchstart', handler);cancelClick = addEventListener(window, 'click', handler);}dispose = () => {cancelClick();cancelTouchStart();};}const { onLayerReady } = propsRef.current;onLayerReady && onLayerReady(node);return dispose;}, [useLayerForClickAway, closeOnClickOutside, node]);useEffect(() => {if (!visible || !closeOnESC) {return noop;}function onKeyUp(e: KeyboardEvent) {const { onClose } = propsRef.current;if (!onClose) {return;}// tslint:disable-next-line deprecationif (e.key === 'Escape' || e.key === 'Esc' || e.keyCode === 27) {onClose(e);}}return addEventListener(document.body, 'keyup', onKeyUp);}, [closeOnESC, visible]);/*** @HACK* @TODO 当React提供了合适的API后替换掉** 这是为了确保在children的componentDidMount(useEffect, useLayoutEffect)在被调用之前把元素挂载到容器里* 这里利用了React的内部实现,MountElement的componentDidMount(useEffect, useLayoutEffect)* 会在children的之前被调用*/return visible && node ? (<PurePortal ref={purePortalRef} append={append} selector={node}><MountElement node={node} getParent={getParent} selector={selector} />{children}</PurePortal>) : null;})

Const PortalContext

PortalContext: Context<IPortalContext> = createContext<IPortalContext>({children: [],})

Position

Position: "/home/runner/work/zent/zent/packages/zent/src/popover/placement/index"

Const QUARTER_NAMES

QUARTER_NAMES: string[] = ['1st Quarter','2nd Quarter','3rd Quarter','4th Quarter',]

Const REF_ID

REF_ID: unique symbol = Symbol('ref')

Const ROW_COUNT

ROW_COUNT: 2 = 2

Const ResizeObserver

ResizeObserver: ResizeObserver = window.ResizeObserver

Const SCROLLBAR_WIDTH

SCROLLBAR_WIDTH: number = getScrollbarWidth()

Const SCROLL_TIME

SCROLL_TIME: 250 = 250

Const SELECT_CREATABLE_KEY

SELECT_CREATABLE_KEY: string = uniqueId('__ZENT_SELECT_CREATABLE_KEY__')

Const SET_ID

SET_ID: unique symbol = Symbol('set')

Const SINGLE_INPUT_WIDTH

SINGLE_INPUT_WIDTH: 136 = 136

Const SOME

SOME: unique symbol = Symbol('some')

START

START: START

Const START_ROTATE

START_ROTATE: 0 = 0

Const STROKE_OFFSET_RATIO

STROKE_OFFSET_RATIO: 0.2 = 0.2

Const STROKE_OPACITY

STROKE_OPACITY: 0.2 = 0.2

Const SYMBOL_REQUIRED

SYMBOL_REQUIRED: unique symbol = Symbol('required')

Const SliderMarks

SliderMarks: NamedExoticComponent<ISliderMarksProps> & { type: T } = memo(({ marks, min, max, potentialValues }: ISliderMarksProps) => (<>{potentialValues.map(value => {return (<divkey={value}style={{left: `${getLeft(value, min, max)}%`,}}className="zent-slider-mark">{marks[value]}</div>);})}</>))

Const TIMEOUT

TIMEOUT: 300 = 300

Const TIME_FORMAT

TIME_FORMAT: "HH:mm:ss" = "HH:mm:ss"

Const TRANSITION_DURATION

TRANSITION_DURATION: 500 = 500

Const Tag

Tag: ForwardRefExoticComponent<ITagProps & RefAttributes<HTMLDivElement>> = forwardRef<HTMLDivElement, ITagProps>(({theme = 'red',outline,rounded = true,closable,children,className,style,onClose,closeButtonStyle,visible = true,},ref) => {if (!visible) {return null;}const colorPart = PRESET_COLOR[theme] ? `-${theme}` : '';const outlinePart = outline ? '-outline' : '';return (<divref={ref}className={cx('zent-tag',`zent-tag-style${colorPart}${outlinePart}`,className,{'zent-tag-rounded': rounded,'zent-tag-closable': closable,})}style={style}><div className="zent-tag-content">{children}</div>{closable ? (<Icontype="close"className="zent-tag-close-btn"onClick={onClose}style={closeButtonStyle}/>) : null}</div>);})

Const TextArea

TextArea: ForwardRefExoticComponent<ITextAreaProps & RefAttributes<HTMLTextAreaElement>> = forwardRef<HTMLTextAreaElement, ITextAreaProps>((props, ref) => {const {value: valueProp,onChange: onChangeProp,onCompositionStart: onCompositionStartProp,onCompositionEnd: onCompositionEndProp,autoSize,showCount,maxLength,width,size,onPressEnter,autoFocus,autoSelect,initSelectionStart,initSelectionEnd,inline,maxCharacterCount,...otherProps} = props;const {value,onChange,onCompositionStart,onCompositionEnd,} = useIMEComposition(valueProp,onChangeProp,onCompositionStartProp,onCompositionEndProp);const textareaRef = ref as React.RefObject<HTMLTextAreaElement>;useLayoutEffect(() => {if (!autoSize) {return noop;}const el = textareaRef.current;if (!el) {return noop;}autosize(el);return () => {destroy(el);};}, [autoSize, textareaRef]);useLayoutEffect(() => {const el = textareaRef.current;if (autoSize && el) {update(el);}}, [value, autoSize, textareaRef]);const isOutOfRange =!!maxCharacterCount && !!value ? value.length > maxCharacterCount : false;return (<><textarea{...otherProps}ref={ref}className={cx('zent-textarea', {'zent-textarea-with-count': showCount,})}value={value}maxLength={maxLength}onChange={onChange}onCompositionStart={onCompositionStart}onCompositionEnd={onCompositionEnd}/>{showCount && (<spanclassName={cx('zent-textarea-count', {'zent-textarea-out-of-range-text': isOutOfRange,})}>{(value || '').length}/{maxLength ?? maxCharacterCount}</span>)}</>);})

Const TimeFormat

TimeFormat: "HH:mm:ss" = "HH:mm:ss"

Const TitleIconMap

TitleIconMap: { error: "close-circle-o"; info: "info-circle-o"; success: "check-circle-o"; warning: "error-circle-o" } = {info: 'info-circle-o',success: 'check-circle-o',error: 'close-circle-o',warning: 'error-circle-o',} as const

Type declaration

  • error: "close-circle-o"
  • info: "info-circle-o"
  • success: "check-circle-o"
  • warning: "error-circle-o"

Const TransitionTimeOut

TransitionTimeOut: 300 = 300

Trigger

Type declaration

Const TriggerPrefixCls

TriggerPrefixCls: "zent-datepicker-trigger" = "zent-datepicker-trigger"

Const XMLNS

XMLNS: "http://www.w3.org/2000/svg" = "http://www.w3.org/2000/svg"

Const XML_NS

XML_NS: "http://www.w3.org/2000/svg" = "http://www.w3.org/2000/svg"

Const YEAR_FORMAT

YEAR_FORMAT: "YYYY" = "YYYY"

Const __DEV__

__DEV__: boolean = process.env.NODE_ENV !== 'production'

Similar to invariant but only logs a warning if the condition is not met. This can be used to log issues in development environments in critical paths. Removing the logging code for production environments will keep the same logic and follow the same code paths. Similar to warning, but only warns once for each id.

Const avaliableStatus

avaliableStatus: IProgressStatus[] = ['normal','success','exception',]

Const buildInDotsColors

buildInDotsColors: string[] = ['black', 'blue', 'red', 'green']

Const canUsePassiveEventListeners

canUsePassiveEventListeners: testPassiveEventListeners = memorize(testPassiveEventListeners)

Let cancelEvent

cancelEvent: () => void = null as () => void

Type declaration

    • (): void
    • Returns void

Const checkboardCache

checkboardCache: {}

Type declaration

Const classNamePrefix

classNamePrefix: "zent-tabs-nav-tabs-content" = "zent-tabs-nav-tabs-content"

Const containerList

containerList: {}

Type declaration

Const context

context: Context<IRadioContext<any>> = createContext<IRadioContext<any> | null>(null)

Const current

current: Date = new Date()

Const d

d: "M5.99995351,10.2785052 L3.0526252,11.9161235 C2.73134341,12.0946367 2.3262008,11.9788615 2.14771388,11.6575325 C2.07507647,11.5267638 2.048604,11.3753341 2.07256714,11.227673 L2.644706,7.70214784 L0.18800271,5.17127401 C-0.0680077998,4.90753426 -0.0617734594,4.4861629 0.201927499,4.23011474 C0.30111659,4.13380419 0.42783327,4.07077947 0.564476058,4.04979499 L3.92629651,3.5335141 L5.39699811,0.384084246 C5.55252473,0.0510321934 5.9485563,-0.0928620579 6.28155937,0.0626874406 C6.42306565,0.128786625 6.53681945,0.242557148 6.60290891,0.384084246 L8.07361051,3.5335141 L11.435431,4.04979499 C11.7987051,4.10558366 12.047978,4.44534453 11.9921975,4.80867212 C11.9712161,4.94533501 11.9082007,5.07207032 11.8119043,5.17127401 L9.35520102,7.70214784 L9.92733988,11.227673 C9.98622287,11.5905106 9.73986227,11.9323896 9.37707808,11.9912813 C9.22943868,12.015248 9.07803132,11.9887716 8.94728182,11.9161235 L5.99995351,10.2785052 Z" = "M5.99995351,10.2785052 L3.0526252,11.9161235 C2.73134341,12.0946367 2.3262008,11.9788615 2.14771388,11.6575325 C2.07507647,11.5267638 2.048604,11.3753341 2.07256714,11.227673 L2.644706,7.70214784 L0.18800271,5.17127401 C-0.0680077998,4.90753426 -0.0617734594,4.4861629 0.201927499,4.23011474 C0.30111659,4.13380419 0.42783327,4.07077947 0.564476058,4.04979499 L3.92629651,3.5335141 L5.39699811,0.384084246 C5.55252473,0.0510321934 5.9485563,-0.0928620579 6.28155937,0.0626874406 C6.42306565,0.128786625 6.53681945,0.242557148 6.60290891,0.384084246 L8.07361051,3.5335141 L11.435431,4.04979499 C11.7987051,4.10558366 12.047978,4.44534453 11.9921975,4.80867212 C11.9712161,4.94533501 11.9082007,5.07207032 11.8119043,5.17127401 L9.35520102,7.70214784 L9.92733988,11.227673 C9.98622287,11.5905106 9.73986227,11.9323896 9.37707808,11.9912813 C9.22943868,12.015248 9.07803132,11.9887716 8.94728182,11.9161235 L5.99995351,10.2785052 Z"

Const dayNames

dayNames: FechaDays = ['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday',]

Const dayNamesShort

dayNamesShort: [string, string, string, string, string, string, string] = shorten(dayNames, 3) as FechaDays

Const dialogInstanceMap

dialogInstanceMap: Map<string, RefObject<StandaloneDialog>> = new Map<string, React.RefObject<StandaloneDialog>>()

Let durationDefault

durationDefault: number = 3500

Const emptyTime

emptyTime: SingleTime = ""

Const emptyTimeRange

emptyTimeRange: RangeTime = ['', '']

Const enquire

enquire: MediaQueryDispatch = supportMediaQuery ? createMediaQueryDispatcher() : null

Const footerPrefixCls

footerPrefixCls: "zent-datepicker-panel-footer" = "zent-datepicker-panel-footer"

Const fourDigits

fourDigits: "\d{4}" = "\d{4}"

Const gEventRegistered

gEventRegistered: false = false

Const generateDate

generateDate: IGenerateDateConfig = dateConfig.year

Const has

has: hasOwnProperty = Object.prototype.hasOwnProperty

Const hasOwnProperty

hasOwnProperty: hasOwnProperty = Object.prototype.hasOwnProperty

Let index

index: number = 0

Const initDate

initDate: DateTuple = [new Date(), new Date()]

Const initTimeDate

initTimeDate: Date = new Date(current.getFullYear(),current.getMonth(),current.getDate())

Const instanceMap

instanceMap: Map<number, RefObject<NoticeWrap>> = new Map<number, React.RefObject<Wrap>>()

isArray

isArray: isArray

Const isChrome

isChrome: boolean = isIOSChrome || isDesktopChrome

Const isChromium

isChromium: boolean = isBrowser && typeof chrome !== 'undefined'

Const isDesktopChrome

isDesktopChrome: boolean = isChromium && vendorName === 'Google Inc.' && !isOpera && !isIEedge

Const isFirefox

isFirefox: boolean = typeof InstallTrigger !== 'undefined'

Const isIEedge

isIEedge: boolean = userAgent && userAgent.indexOf('Edge') > -1

Const isIOSChrome

isIOSChrome: boolean = !!(userAgent && userAgent.match('CriOS'))

Const isOpera

isOpera: boolean = isBrowser && typeof opr !== 'undefined'

Const literal

literal: RegExp = /\[([^]*?)\]/gm

Let locale

Const map

map: Map<HTMLTextAreaElement, IMethods> = new Map<HTMLTextAreaElement, IMethods>()

Const mark

mark: "en-US" = "en-US"

Const memoizedLowercaseProps

memoizedLowercaseProps: lowercaseProps = memoizeOne(lowercaseProps)

Const memoizedNormalizeSelectOptions

memoizedNormalizeSelectOptions: normalizeSelectOptions = memoize(function normalizeSelectOptions(pageSizeOptions: PaginationPageSizeOption[],i18n: II18nLocalePagination): ISelectItem<number>[] {return (pageSizeOptions || []).map(opt => {if (typeof opt === 'number') {return { key: opt, text: `${opt} ${i18n.items}` };}return {key: opt.value,text: opt.text,};});})

Const menuListPaddingTop

menuListPaddingTop: 0 = 0

Const monthNames

monthNames: FechaMonths = ['January','February','March','April','May','June','July','August','September','October','November','December',]

Const monthNamesShort

monthNamesShort: [string, string, string, string, string, string, string, string, string, string, string, string] = shorten(monthNames, 3) as FechaMonths

Let mousePosition

mousePosition: IMousePosition | null = null

Const msPattern

msPattern: RegExp = /^ms-/

Const notifyContainerClass

notifyContainerClass: "zent-notify-container" = "zent-notify-container"

Const now

now: any = w.performance && w.performance.now? w.performance.now.bind(w.performance): Date.now

Const objIs

objIs: is = Object.is

Const objKeys

objKeys: keys = Object.keys

Const oneGB

oneGB: number = 1024 * oneMB

Const oneKB

oneKB: 1024 = 1024

Const oneMB

oneMB: number = 1024 * 1024

Const originalScroll

originalScroll: scroll = w.scroll || w.scrollTo

Const patched

patched: Map<HTMLElement, IPatchMeta> = new Map<HTMLElement, IPatchMeta>()

Const prefixCls

prefixCls: "zent-datepicker-combined-panel" = "zent-datepicker-combined-panel"

Const prefixes

prefixes: string[] = ['Webkit', 'ms', 'Moz', 'O']

Support style names that may come passed in prefixed by adding permutations of vendor prefixes.

Const properties

properties: string[] = ['direction', // RTL support'boxSizing','width', // on Chrome and IE, exclude the scrollbar, so the mirror div wraps exactly as the textarea does'height','overflowX','overflowY', // copy the scrollbar for IE'borderTopWidth','borderRightWidth','borderBottomWidth','borderLeftWidth','borderStyle','paddingTop','paddingRight','paddingBottom','paddingLeft',// https://developer.mozilla.org/en-US/docs/Web/CSS/font'fontStyle','fontVariant','fontWeight','fontStretch','fontSize','fontSizeAdjust','lineHeight','fontFamily','textAlign','textTransform','textIndent','textDecoration', // might not make a difference, but better be safe'letterSpacing','wordSpacing','tabSize','MozTabSize',]

Let scrollbarWidth

scrollbarWidth: number = 0

Const sortableJS

sortableJS: typeof _sortableJS = (_sortableJS as any).default

Const subscriberList

subscriberList: any[] = []

Const supportMediaQuery

supportMediaQuery: matchMedia & matchMedia = isBrowser && window.matchMedia

Const targetMap

targetMap: WeakMap<EventTarget, TargetEventHandlers<string>> = new WeakMap<EventTarget, TargetEventHandlers>()

Const threeDigits

threeDigits: "\d{3}" = "\d{3}"

Const timePanelProps

timePanelProps: ["format", "hourStep", "minuteStep", "secondStep"] = ['format','hourStep','minuteStep','secondStep',] as const

Const toString

toString: toString = Object.prototype.toString

Const today

today: Date = new Date()

Const token

token: RegExp = /d{1,4}|M{1,4}|YY(?:YY)?|S{1,3}|Do|ZZ|([HhMsDm])\1?|[aA]|"[^"]*"|'[^']*'/g

Const triggerCommonProps

triggerCommonProps: ["width", "name", "format", "seperator", "canClear", "placeholder"] = ['width','name','format','seperator','canClear','placeholder',] as const

Const twoDigits

twoDigits: "\d\d?" = "\d\d?"

Const uppercasePattern

uppercasePattern: RegExp = /([A-Z])/g

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

flow

Const useIMEComposition

useIMEComposition: useIMEComposition = createUseIMEComposition()

Const userAgent

userAgent: string = winNav && winNav.userAgent

Const valueOfSymbol

valueOfSymbol: valueOf = Symbol.prototype.valueOf

Const vendorName

vendorName: string = winNav && winNav.vendor

Let viewportHeight

viewportHeight: number = 0

Let viewportWidth

viewportWidth: number = 0

Const w

w: Window = isBrowser ? window : ({} as Window)

Const winNav

winNav: Navigator = isBrowser && window.navigator

Const withPopover

withPopover: <T>(Comp: React.ComponentType<T>) => React.ComponentType<Omit<T, "popover">> = Popover.withPopover

Type declaration

    • <T>(Comp: React.ComponentType<T>): React.ComponentType<Omit<T, "popover">>
    • Type parameters

      Parameters

      • Comp: React.ComponentType<T>

      Returns React.ComponentType<Omit<T, "popover">>

Const word

word: "[^\s]+" = "[^\s]+"

Functions

Const AllCheckBox

  • AllCheckBox(__namedParameters: { classNamePrefix: string; compontentDisabled: boolean; handleCheckBoxChange: (e: ICheckboxEvent<boolean>) => void; i18n: II18nLocaleTransfer; isAllChecked: boolean; listDataLength: number; selectedKeysLength: number; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { classNamePrefix: string; compontentDisabled: boolean; handleCheckBoxChange: (e: ICheckboxEvent<boolean>) => void; i18n: II18nLocaleTransfer; isAllChecked: boolean; listDataLength: number; selectedKeysLength: number; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • classNamePrefix: string
      • compontentDisabled: boolean
      • handleCheckBoxChange: (e: ICheckboxEvent<boolean>) => void
      • i18n: II18nLocaleTransfer
      • isAllChecked: boolean
      • listDataLength: number
      • selectedKeysLength: number
      • title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

Const AnchorOperation

  • AnchorOperation<Id>(__namedParameters: { onChange: (item: IInnerTab<Id>) => void; tabs: IInnerTab<Id>[] }): Element

Const Arrow

  • Arrow(__namedParameters: { className: string }): Element
  • Arrow(__namedParameters: { onClick: () => void; type: "left" | "right" }): Element

Const ArrowBottomLeftPosition

  • ArrowBottomLeftPosition(__namedParameters: { cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowBottomRightPosition

  • ArrowBottomRightPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowButton

  • ArrowButton(__namedParameters: { direction: "left" | "right"; disabled: boolean; onChange: () => void; prefix: string }): Element
  • Parameters

    • __namedParameters: { direction: "left" | "right"; disabled: boolean; onChange: () => void; prefix: string }
      • direction: "left" | "right"
      • disabled: boolean
      • onChange: () => void
          • (): void
          • Returns void

      • prefix: string

    Returns Element

constructor

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Readonly props

props: Readonly<IPaginationArrowButtonProps & Partial<IButtonProps>> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

render

  • render(): Element

setState

  • Type parameters

    • K: keyof S

    Parameters

    Returns void

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Static defaultProps

defaultProps: object

active

active: boolean = false

bordered

bordered: boolean = true

double

double: boolean = false

Const ArrowLeftBottomPosition

  • ArrowLeftBottomPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowLeftTopPosition

  • ArrowLeftTopPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowRightBottomPosition

  • ArrowRightBottomPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowRightTopPosition

  • ArrowRightTopPosition(__namedParameters: { cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowTopLeftPosition

  • ArrowTopLeftPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const ArrowTopRightPosition

  • ArrowTopRightPosition(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): IPopoverPosition

Const AutoBottomCenter

Const AutoBottomLeft

Const AutoBottomLeftInViewport

Const AutoBottomRight

Const AutoTopCenter

Const AutoTopLeft

Const AutoTopRight

BlockLoading

Const BottomCenter

  • BottomCenter(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | anchor | | |


    popover

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const BottomLeft

  • BottomLeft(__namedParameters: { cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | anchor | | |


    popover

    Parameters

    • __namedParameters: { cushion: number; relativeRect: ClientRect }
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const BottomLeftInViewport

  • BottomLeftInViewport(__namedParameters: { anchorRect: DOMRect | ClientRect; contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • ---------------- | | anchor | | | | | ---------------- | |popoverpopoverpopover|

    Parameters

    • __namedParameters: { anchorRect: DOMRect | ClientRect; contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • anchorRect: DOMRect | ClientRect
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const BottomRight

  • BottomRight(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | anchor | | |


       |popover|
       ---------

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

ButtonDirective

Const ButtonGroup

  • ButtonGroup(__namedParameters: { className: string; props: props }): Element

CascaderTag

CascaderTagList

Const Checkboard

  • Checkboard(__namedParameters: { grey: any; renderers: any; size: any; white: any }): Element

Checkbox

CheckboxField

  • CheckboxField<Value>(__namedParameters: { childProps: IFormFieldChildProps<boolean>; props: ({} & { props?: Partial<Props> } & {} & {}) | ({} & { props?: Partial<Props> } & {} & {}) }): Element

CircleIcon

  • CircleIcon(__namedParameters: { colorPreset: "primary" | "grey"; size: number; text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; textPosition: "left" | "top" | "right" | "bottom" }): Element
  • Parameters

    • __namedParameters: { colorPreset: "primary" | "grey"; size: number; text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; textPosition: "left" | "top" | "right" | "bottom" }
      • colorPreset: "primary" | "grey"
      • size: number
      • text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • textPosition: "left" | "top" | "right" | "bottom"

    Returns Element

Const CircleProgress

Const ColorWrap

  • ColorWrap(Picker: any): ComponentClass<any, any>

Const CombinedDateRangeFooter

  • CombinedDateRangeFooter(__namedParameters: { disabledConfirm: boolean; disabledEndTimes: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; disabledStartTimes: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; format: string; onSelected: (val: DateNullTuple, status?: boolean) => void; selected: [Date, Date] }): Element

Const CombinedDateRangePanel

  • CombinedDateRangePanel(__namedParameters: { defaultPanelDate: [Date, Date]; disabledEndDate: (date: Date) => boolean; disabledStartDate: (date: Date) => boolean; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; onSelected: (val: DateNullTuple, status?: boolean) => void; restProps: restProps; selected: [Date, Date]; showTime: false | true | IShowTimeRangeOption<string> }): Element

Const CombinedDateRangePicker

Const CombinedInputTrigger

  • CombinedInputTrigger(__namedParameters: { canClear: boolean; disabled: boolean; format: string; icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"; name: [string, string]; onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void; placeholder: [string, string]; restProps: restProps; selected: [Date, Date]; seperator: string; value: [string | number | Date, string | number | Date] }): Element
  • Parameters

    • __namedParameters: { canClear: boolean; disabled: boolean; format: string; icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"; name: [string, string]; onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void; placeholder: [string, string]; restProps: restProps; selected: [Date, Date]; seperator: string; value: [string | number | Date, string | number | Date] }
      • canClear: boolean
      • disabled: boolean
      • format: string
      • icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"
      • name: [string, string]
      • onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void
          • (event: MouseEvent<HTMLElement, MouseEvent>): void
          • Parameters

            • event: MouseEvent<HTMLElement, MouseEvent>

            Returns void

      • placeholder: [string, string]
      • restProps: restProps
      • selected: [Date, Date]
      • seperator: string
      • value: [string | number | Date, string | number | Date]

    Returns Element

Const CombinedPicker

  • CombinedPicker(__namedParameters: { dateSpan: number; disabled: boolean; disabledDateProps: ((date: Date, type?: RangeType) => boolean) | IDisabledDateSimple<string | number | Date>; onChange: (date: SingleDate | RangeDate | null) => void; onClose: (type?: RangeType) => void; onOpen: (type?: RangeType) => void; restProps: restProps; value: [string | number | Date, string | number | Date] }): Element

Const CombinedTimeFooter

  • CombinedTimeFooter(__namedParameters: { onSelected: (val: T, status?: boolean) => void; selected: [string, string] }): Element

Const CombinedTimePicker

  • CombinedTimePicker(__namedParameters: { ContentComponent: ComponentClass<ICombinedTimePanelProps, any> | FunctionComponent<ICombinedTimePanelProps>; defaultTime: [string, string]; disabled: boolean; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; onChange: (date: T) => void; onClose: () => void; onOpen: () => void; restProps: restProps; selectedDate: Date; value: [string, string] }): Element

Const CombinedTimeRangePanel

  • CombinedTimeRangePanel(__namedParameters: { defaultTime: [string, string]; disabledTimeOptionEnd: IDisabledTimeOption; disabledTimeOptionStart: IDisabledTimeOption; onSelected: (val: T, status?: boolean) => void; restProps: restProps; selected: [string, string] }): Element

Const CombinedTimeRangePicker

Const DatePicker

Const DatePickerBody

Const DatePickerFooter

  • DatePickerFooter(__namedParameters: { disabledPanelDate: (val: Date) => boolean; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; footerText: string; onSelected: (val: Date, status?: boolean) => void; selected: Date; showTime: false | true | IShowTimeOption<string>; showTimeOption: {} & {} }): Element

Const DatePickerPanel

Const DateRangePicker

Const DateRangeQuickPickerField

  • DateRangeQuickPickerField(__namedParameters: { childProps: IFormFieldChildProps<[string | number | Date, string | number | Date]>; props: ({} & { props?: Partial<Props> } & {} & {}) | ({} & { props?: Partial<Props> } & {} & {}) }): Element

Const Disabled

  • Disabled(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; value: boolean }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; value: boolean }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • value: boolean

    Returns Element

Dots

  • Dots(__namedParameters: { activeLeft: number; activeRight: number; disabled: boolean; max: number; min: number; potentialValues: number[] }): Element
  • Parameters

    • __namedParameters: { activeLeft: number; activeRight: number; disabled: boolean; max: number; min: number; potentialValues: number[] }
      • activeLeft: number
      • activeRight: number
      • disabled: boolean
      • max: number
      • min: number
      • potentialValues: number[]

    Returns Element

Const DoubleArrow

  • DoubleArrow(__namedParameters: { onClick: () => void; type: "left" | "right" }): Element

Const Drawer

  • Drawer(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; closeOnESC: boolean; footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; mask: boolean; maskClosable: boolean; onClose: () => void; placement: "left" | "top" | "right" | "bottom"; rest: rest | rest; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; visible: boolean }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; closeOnESC: boolean; footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; mask: boolean; maskClosable: boolean; onClose: () => void; placement: "left" | "top" | "right" | "bottom"; rest: rest | rest; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; visible: boolean }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • className: string
      • closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • closeOnESC: boolean
      • footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • mask: boolean
      • maskClosable: boolean
      • onClose: () => void
          • (): void
          • Returns void

      • placement: "left" | "top" | "right" | "bottom"
      • rest: rest | rest
      • title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • visible: boolean

    Returns Element

Const DrawerBackdrop

  • DrawerBackdrop(__namedParameters: { mask: boolean; maskClosable: boolean; onClose: () => void; visible: boolean }): Element
  • Parameters

    • __namedParameters: { mask: boolean; maskClosable: boolean; onClose: () => void; visible: boolean }
      • mask: boolean
      • maskClosable: boolean
      • onClose: () => void
          • (): void
          • Returns void

      • visible: boolean

    Returns Element

Const DrawerContent

  • DrawerContent(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; mask: boolean; onClose: () => void; onExited: () => void; placement: "left" | "top" | "right" | "bottom"; rest: rest | rest; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; visible: boolean }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; mask: boolean; onClose: () => void; onExited: () => void; placement: "left" | "top" | "right" | "bottom"; rest: rest | rest; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; visible: boolean }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • closeBtn: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • footer: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • mask: boolean
      • onClose: () => void
          • (): void
          • Returns void

      • onExited: () => void
          • (): void
          • Returns void

      • placement: "left" | "top" | "right" | "bottom"
      • rest: rest | rest
      • title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • visible: boolean

    Returns Element

Const Dropdown

  • Dropdown(__namedParameters: { className: string; cushion: number; onVisibleChange: (visible: boolean) => void; rest: rest; visible: boolean }): Element
  • Parameters

    • __namedParameters: { className: string; cushion: number; onVisibleChange: (visible: boolean) => void; rest: rest; visible: boolean }
      • className: string
      • cushion: number
      • onVisibleChange: (visible: boolean) => void
          • (visible: boolean): void
          • Parameters

            • visible: boolean

            Returns void

      • rest: rest
      • visible: boolean

    Returns Element

Const DropdownButton

  • DropdownButton(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; props: props }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; props: props }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • className: string
      • props: props

    Returns Element

ErrorBoundaryFallbackComponent

  • ErrorBoundaryFallbackComponent(__namedParameters: { componentStack: any; error: any }): Element

Const EventHandler

  • EventHandler<E, N, T>(__namedParameters: { eventName: N; listener: (event: E) => void; options: AddEventListenerOptions; target: T }): any
  • Type parameters

    • E: Event

    • N: string

    • T: EventTarget

    Parameters

    • __namedParameters: { eventName: N; listener: (event: E) => void; options: AddEventListenerOptions; target: T }
      • eventName: N
      • listener: (event: E) => void
          • (event: E): void
          • Parameters

            • event: E

            Returns void

      • options: AddEventListenerOptions
      • target: T

    Returns any

FieldSet

FieldSetValue

  • FieldSetValue(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; modelProps: FieldSetModel<{}>; name: string }): Element
  • 根据 name 订阅 FieldSet 的值

    Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; modelProps: FieldSetModel<{}>; name: string }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • modelProps: FieldSetModel<{}>
      • name: string

    Returns Element

FieldValid

FieldValue

FormCheckboxField

FormCheckboxGroupField

Const FormColorPickerField

  • FormColorPickerField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormCombinedDateRangePickerField

Const FormCombinedTimeRangePickerField

  • FormCombinedTimeRangePickerField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormDatePickerField

Const FormDateRangePickerField

Const FormDateRangeQuickPickerField

  • FormDateRangeQuickPickerField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormDescription

  • FormDescription(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; style: CSSProperties }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; style: CSSProperties }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • className: string
      • style: CSSProperties

    Returns Element

FormField

FormImageUploadField

Const FormInputField

  • FormInputField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormMonthPickerField

Const FormNotice

  • FormNotice(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; style: CSSProperties }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; style: CSSProperties }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • className: string
      • style: CSSProperties

    Returns Element

FormNumberInputField

Const FormQuarterPickerField

FormRadioGroupField

FormSelectField

FormSingleUploadField

Const FormSwitchField

  • FormSwitchField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormTimePickerField

  • FormTimePickerField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

Const FormTimeRangePickerField

  • FormTimeRangePickerField(props: ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: ReactNode })): Element

FormUploadField

Const FormWeekPickerField

Const FormYearPickerField

FullScreenLoading

Const IMEComposition

  • IMEComposition(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; enable: boolean }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; enable: boolean }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • enable: boolean

    Returns Element

Const ImageUploadItem

InlineLoading

Const InputField

  • InputField(__namedParameters: { childProps: IFormFieldChildProps<string>; props: ({} & { props?: Partial<Props> } & {} & {}) | ({} & { props?: Partial<Props> } & {} & {}) }): Element

Const Label

  • Label(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; required: boolean }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; required: boolean }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • required: boolean

    Returns Element

LeftArrow

  • LeftArrow(): Element

Const LeftBottom

  • LeftBottom(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }
  •       |--------------------|

    ----------| | | popover | anchor | |---------|--------------------|

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const LeftCenter

  • LeftCenter(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }
  •       |--------------------|

    ----------| | | popover | anchor | |---------| | |--------------------|

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

LeftDoubleArrow

  • LeftDoubleArrow(): Element

Const LeftTop

  • LeftTop(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • popover anchor

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const LineProgress

Loading

  • Loading(): Element

LoadingMask

Const MonthPicker

Const MonthPickerBody

  • MonthPickerBody(__namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }): Element
  • Parameters

    • __namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }
      • col: number
      • defaultPanelDate: Date
      • disabledPanelDate: (val: Date) => boolean
          • (val: Date): boolean
          • Parameters

            • val: Date

            Returns boolean

      • onSelected: (val: Date, status?: boolean) => void
          • (val: Date, status?: boolean): void
          • Parameters

            • val: Date
            • Optional status: boolean

            Returns void

      • row: number
      • selected: Date

    Returns Element

Const MonthPickerPanel

Const MountElement

  • MountElement(__namedParameters: { getParent: getParent; node: HTMLElement; selector: string | Element }): any

Const None

  • None(): any

Const NormalUploadItem

Notice

  • Notice(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; closable: boolean; onClose: () => void; style: CSSProperties; title: string; type: "error" | "info" | "success" | "warning" }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; className: string; closable: boolean; onClose: () => void; style: CSSProperties; title: string; type: "error" | "info" | "success" | "warning" }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • className: string
      • closable: boolean
      • onClose: () => void
          • (): void
          • Returns void

      • style: CSSProperties
      • title: string
      • type: "error" | "info" | "success" | "warning"

    Returns Element

Const NotifyTransition

  • NotifyTransition(__namedParameters: { children: any; props: props }): Element

Const PanelCell

  • PanelCell(__namedParameters: { cells: IDateCellBase[]; col: number; onHover: (val: Date) => void; onSelected: (val: Date) => void; popText: string }): Element
  • Parameters

    • __namedParameters: { cells: IDateCellBase[]; col: number; onHover: (val: Date) => void; onSelected: (val: Date) => void; popText: string }
      • cells: IDateCellBase[]
      • col: number
      • onHover: (val: Date) => void
          • (val: Date): void
          • Parameters

            • val: Date

            Returns void

      • onSelected: (val: Date) => void
          • (val: Date): void
          • Parameters

            • val: Date

            Returns void

      • popText: string

    Returns Element

Const PanelFooter

  • PanelFooter(__namedParameters: { leftNode: {}; rightNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { leftNode: {}; rightNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • leftNode: {}
      • rightNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

Const PanelHeader

  • PanelHeader(__namedParameters: { combinedLeft: boolean; combinedRight: boolean; onNext: () => void; onPrev: () => void; onSuperNext: noop; onSuperPrev: noop; showSuper: boolean; titleNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { combinedLeft: boolean; combinedRight: boolean; onNext: () => void; onPrev: () => void; onSuperNext: noop; onSuperPrev: noop; showSuper: boolean; titleNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • combinedLeft: boolean
      • combinedRight: boolean
      • onNext: () => void
          • (): void
          • Returns void

      • onPrev: () => void
          • (): void
          • Returns void

      • onSuperNext: noop
      • onSuperPrev: noop
      • showSuper: boolean
      • titleNode: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

Const PanelSubHeader

  • PanelSubHeader(__namedParameters: { names: string[] }): Element

Const PickerPopover

  • PickerPopover(__namedParameters: { content: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; onVisibleChange: (visible: boolean) => void; panelVisible: boolean; trigger: ReactElement<IPopoverClickTriggerChildProps, any> }): Element
  • Parameters

    • __namedParameters: { content: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; onVisibleChange: (visible: boolean) => void; panelVisible: boolean; trigger: ReactElement<IPopoverClickTriggerChildProps, any> }
      • content: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • onVisibleChange: (visible: boolean) => void
          • (visible: boolean): void
          • Parameters

            • visible: boolean

            Returns void

      • panelVisible: boolean
      • trigger: ReactElement<IPopoverClickTriggerChildProps, any>

    Returns Element

PopAction

  • PopAction(__namedParameters: { cancelPending: boolean; cancelText: string; changePending: IChangePending; confirmPending: boolean; confirmText: string; onCancel: (() => Promise<void>) | ((close: () => void) => void); onConfirm: (() => Promise<void>) | ((close: () => void) => void); type: "success" | "primary" | "default" | "secondary" | "danger" }): Element
  • Parameters

    • __namedParameters: { cancelPending: boolean; cancelText: string; changePending: IChangePending; confirmPending: boolean; confirmText: string; onCancel: (() => Promise<void>) | ((close: () => void) => void); onConfirm: (() => Promise<void>) | ((close: () => void) => void); type: "success" | "primary" | "default" | "secondary" | "danger" }
      • cancelPending: boolean
      • cancelText: string
      • changePending: IChangePending
      • confirmPending: boolean
      • confirmText: string
      • onCancel: (() => Promise<void>) | ((close: () => void) => void)
      • onConfirm: (() => Promise<void>) | ((close: () => void) => void)
      • type: "success" | "primary" | "default" | "secondary" | "danger"

    Returns Element

PopoverClickTrigger

  • PopoverClickTrigger<ChildProps>(__namedParameters: { children: string | number | ((childProps: IPopoverClickTriggerChildProps) => React.ReactNode) | ReactElement<ChildProps, any>; closeOnClickOutside: boolean; getElement: (node: Element | Text | null) => Element | Text | null; toggle: boolean }): Element

PopoverContent

  • PopoverContent(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

PopoverFocusTrigger

  • PopoverFocusTrigger<ChildProps>(__namedParameters: { children: string | number | ((childProps: IPopoverFocusTriggerChildProps) => React.ReactNode) | ReactElement<ChildProps, any>; getElement: (node: Element | Text | null) => Element | Text | null }): Element

PopoverHoverTrigger

Const Progress

Const ProgressInfo

Const QuarterPicker

Const QuarterPickerBody

  • QuarterPickerBody(__namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }): Element
  • Parameters

    • __namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }
      • col: number
      • defaultPanelDate: Date
      • disabledPanelDate: (val: Date) => boolean
          • (val: Date): boolean
          • Parameters

            • val: Date

            Returns boolean

      • onSelected: (val: Date, status?: boolean) => void
          • (val: Date, status?: boolean): void
          • Parameters

            • val: Date
            • Optional status: boolean

            Returns void

      • row: number
      • selected: Date

    Returns Element

Const QuarterPickerPanel

  • QuarterPickerPanel(props: {} & { children?: ReactNode }): Element

Radio

  • Radio<Value>(props: IRadioProps<Value> & { labelStyle?: CSSProperties }): Element

RadioButton

  • RadioButton<Value>(props: IRadioProps<Value>): Element

RadioGroup

RadioGroupField

  • RadioGroupField<T>(__namedParameters: { childProps: IFormFieldChildProps<T>; props: ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode }) }): Element
  • Type parameters

    • T

    Parameters

    • __namedParameters: { childProps: IFormFieldChildProps<T>; props: ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode }) }
      • childProps: IFormFieldChildProps<T>
      • props: ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode }) | ({} & { props?: Partial<Props> } & {} & {} & { children?: React.ReactNode })

    Returns Element

Const ReactCSS

  • ReactCSS<T>(classes: T, ...activations: any[]): {}

RightArrow

  • RightArrow(): Element

Const RightBottom

  • RightBottom(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | |---------- | anchor | popover | |--------------------|---------

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const RightCenter

  • RightCenter(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | |---------- | anchor | popover | | |--------- |--------------------|

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

RightDoubleArrow

  • RightDoubleArrow(): Element

Const RightTop

  • RightTop(__namedParameters: { cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • | anchor | popover | | |---------


    Parameters

    • __namedParameters: { cushion: number; relativeRect: ClientRect }
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const Search

  • Search(__namedParameters: { classNamePrefix: string; handleInputChange: (e: ChangeEvent<HTMLTextAreaElement>) => void; i18n: II18nLocaleTransfer; inputVal: string; searchPlaceholder: string; showSearch: boolean }): Element
  • Parameters

    • __namedParameters: { classNamePrefix: string; handleInputChange: (e: ChangeEvent<HTMLTextAreaElement>) => void; i18n: II18nLocaleTransfer; inputVal: string; searchPlaceholder: string; showSearch: boolean }
      • classNamePrefix: string
      • handleInputChange: (e: ChangeEvent<HTMLTextAreaElement>) => void
          • (e: ChangeEvent<HTMLTextAreaElement>): void
          • Parameters

            • e: ChangeEvent<HTMLTextAreaElement>

            Returns void

      • i18n: II18nLocaleTransfer
      • inputVal: string
      • searchPlaceholder: string
      • showSearch: boolean

    Returns Element

SearchInput

SelectOption

  • SelectOption<Key, Item>(__namedParameters: { active: boolean; children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; index: number; loading: boolean; multiple: boolean; onMouseEnter: onMouseEnter; onMouseLeave: onMouseLeave; onSelect: onSelect; selected: boolean; value: Item }): Element
  • Type parameters

    Parameters

    • __namedParameters: { active: boolean; children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; index: number; loading: boolean; multiple: boolean; onMouseEnter: onMouseEnter; onMouseLeave: onMouseLeave; onSelect: onSelect; selected: boolean; value: Item }
      • active: boolean
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • index: number
      • loading: boolean
      • multiple: boolean
      • onMouseEnter: onMouseEnter
      • onMouseLeave: onMouseLeave
      • onSelect: onSelect
      • selected: boolean
      • value: Item

    Returns Element

SelectSearch

  • SelectSearch(__namedParameters: { autoWidth: boolean; onChangeProp: bivarianceHack; onEnter: onEnter; onIndexChange: onIndexChange; placeholder: string; valueProp: string }, cmdRef: React.ForwardedRef<ISelectImperativeHandlers>): Element

SelectTag

  • SelectTag<Key, Item>(__namedParameters: { item: Item; onRemove: onRemove; renderValue: (value: Item) => React.ReactNode }): Element
  • Type parameters

    Parameters

    • __namedParameters: { item: Item; onRemove: onRemove; renderValue: (value: Item) => React.ReactNode }
      • item: Item
      • onRemove: onRemove
      • renderValue: (value: Item) => React.ReactNode
          • (value: Item): React.ReactNode
          • Parameters

            • value: Item

            Returns React.ReactNode

    Returns Element

SelectTagList

  • SelectTagList<Key, Item>(__namedParameters: { list: Item[]; onRemove: onRemove; renderValue: (value: Item) => React.ReactNode }): Element
  • Type parameters

    Parameters

    • __namedParameters: { list: Item[]; onRemove: onRemove; renderValue: (value: Item) => React.ReactNode }
      • list: Item[]
      • onRemove: onRemove
      • renderValue: (value: Item) => React.ReactNode
          • (value: Item): React.ReactNode
          • Parameters

            • value: Item

            Returns React.ReactNode

    Returns Element

Const SingleInputTrigger

  • SingleInputTrigger(__namedParameters: { canClear: boolean; disabled: boolean; format: string; hiddenIcon: boolean; icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"; name: string; onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void; placeholder: string; restProps: restProps; seperator: string; text: string | [string, string]; value: string | number | Date }): Element
  • Parameters

    • __namedParameters: { canClear: boolean; disabled: boolean; format: string; hiddenIcon: boolean; icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"; name: string; onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void; placeholder: string; restProps: restProps; seperator: string; text: string | [string, string]; value: string | number | Date }
      • canClear: boolean
      • disabled: boolean
      • format: string
      • hiddenIcon: boolean
      • icon: "left" | "right" | "hr" | "link" | "summary" | "video" | "drag" | "message" | "close" | "warning" | "add-page" | "approval" | "approval-o" | "arrow-down" | "arrow-up" | "assess" | "assess-o" | "back" | "bell" | "bell-o" | "business" | "business-o" | "calendar" | "calendar-o" | "capital" | "capital-o" | "caret-down" | "caret-up" | "casher" | "cashier" | "cashier-desk-o" | "channel-o" | "chart" | "chart-o" | "check" | "check-circle" | "check-circle-o" | "checkin" | "checkin-o" | "clock" | "clock-o" | "close-circle" | "close-circle-o" | "closed-eye" | "contract-o" | "countdown" | "coupon" | "coupon-o" | "customer" | "customer-o" | "customer-service" | "development-doc" | "distribution-o" | "doc" | "down" | "down-circle" | "down-circle-o" | "download" | "edit-o" | "error-circle" | "error-circle-o" | "expand-customer" | "expand-customer-o" | "export" | "eye" | "eye-o" | "feedback" | "filter-o" | "flow-o" | "folder-o" | "forbidden-circle" | "gift" | "goods" | "goods-o" | "hc-manage" | "hc-manage-o" | "help-circle" | "help-circle-o" | "hotline-o" | "hr-o" | "im-o" | "info-circle" | "info-circle-o" | "inventory" | "inventory-o" | "knowledge-o" | "left-circle" | "left-circle-o" | "lock" | "marketing" | "member-o" | "message-o" | "mini-apps" | "mini-apps-o" | "more" | "nav-grid" | "nav-line" | "open-folder-o" | "order" | "order-o" | "pending-circle" | "pending-payment-o" | "photo" | "plus" | "plus-circle" | "plus-circle-o" | "procurement" | "procurement-o" | "qa-o" | "qrcode" | "refresh" | "remove-o" | "report" | "report-forms" | "report-forms-o" | "report-o" | "right-circle" | "right-circle-o" | "rights-list-o" | "salesman-o" | "save-o" | "scan-code-o" | "search" | "settings" | "settings-o" | "share" | "shop" | "shop-analyze-o" | "shop-decorate" | "shop-o" | "shop-template" | "smile" | "star" | "star-o" | "strategy-o" | "subtract-circle" | "subtract-circle-o" | "suggestions" | "summary-o" | "tendency-o" | "text-guide-o" | "thumbnail" | "ticket" | "ticket-o" | "tools-o" | "unlock" | "up" | "up-circle" | "up-circle-o" | "upload" | "video-guide-o" | "visit-o" | "voice" | "warning-o" | "wechat" | "withdraw-cash-o" | "youzan" | "youzan-o"
      • name: string
      • onClearInput: (event: MouseEvent<HTMLElement, MouseEvent>) => void
          • (event: MouseEvent<HTMLElement, MouseEvent>): void
          • Parameters

            • event: MouseEvent<HTMLElement, MouseEvent>

            Returns void

      • placeholder: string
      • restProps: restProps
      • seperator: string
      • text: string | [string, string]
      • value: string | number | Date

    Returns Element

SinglePicker

  • SinglePicker(__namedParameters: { disabledDate: ((date: Date) => boolean) | IDisabledDateSimple<string | number | Date>; onChange: (date: SingleDate | RangeDate | null) => void; onClose: () => void; onOpen: () => void; restProps: restProps; value: string | number | Date }): Element

Const SingleUploadItem

Const Sketch

  • Sketch(__namedParameters: { className: any; hex: any; hsl: any; hsv: any; onChange: any; presetColors: any; renderers: any; rgb: any; showAlpha: any; type: any; width: any }): Element
  • Parameters

    • __namedParameters: { className: any; hex: any; hsl: any; hsv: any; onChange: any; presetColors: any; renderers: any; rgb: any; showAlpha: any; type: any; width: any }
      • className: any
      • hex: any
      • hsl: any
      • hsv: any
      • onChange: any
      • presetColors: any
      • renderers: any
      • rgb: any
      • showAlpha: any
      • type: any
      • width: any

    Returns Element

Const SketchPresetColors

  • SketchPresetColors(__namedParameters: { colors: string[]; onClick: onClick; type: "default" | "simple" }): Element

SlideOperation

  • SlideOperation(__namedParameters: { disableNext: boolean; disablePrev: boolean; onNextChange: () => void; onPrevChange: () => void }): Element
  • Parameters

    • __namedParameters: { disableNext: boolean; disablePrev: boolean; onNextChange: () => void; onPrevChange: () => void }
      • disableNext: boolean
      • disablePrev: boolean
      • onNextChange: () => void
          • (): void
          • Returns void

      • onPrevChange: () => void
          • (): void
          • Returns void

    Returns Element

SliderPoint

Const Some

  • Some<T>(value: T): ISome<T>

Const StarIcon

  • StarIcon(props: { className: string }): Element

Const Swatch

  • Swatch(__namedParameters: { color: any; onClick: any; style: any; title: any }): Element

TabDivide

  • TabDivide(_props: React.PropsWithChildren<Partial<IVerticalDivide>>): any

Const TabPanel

  • TabPanel<Id>(props: React.PropsWithChildren<ITabPanelProps<Id>>): Element

Const Text

  • Text(props: { type: "middle" | "right" } & { children?: ReactNode }): Element

TextMark

  • TextMark(__namedParameters: { activeClassName: string; activeIndex: number; activeStyle: CSSProperties; autoEscape: boolean; caseSensitive: boolean; className: string; findChunks: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]; highlightClassName: string | {}; highlightStyle: CSSProperties; highlightTag: "symbol" | "object" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "menu" | "menuitem" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "slot" | "script" | "section" | "select" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "template" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | FunctionComponent<any> | "text" | "circle" | "view" | "pattern" | ComponentClass<any, any> | "animate" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "textPath" | "tspan" | "use" | "noindex" | "animateMotion" | "animateTransform" | "mpath"; rest: rest; sanitize: (str: string) => string; searchWords: (string | RegExp)[]; textToHighlight: string; unhighlightClassName: string; unhighlightStyle: CSSProperties }): Element
  • Highlights all occurrences of search terms (searchText) within a string (textToHighlight). This function returns an array of strings and s (wrapping highlighted words).

    Parameters

    • __namedParameters: { activeClassName: string; activeIndex: number; activeStyle: CSSProperties; autoEscape: boolean; caseSensitive: boolean; className: string; findChunks: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]; highlightClassName: string | {}; highlightStyle: CSSProperties; highlightTag: "symbol" | "object" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "menu" | "menuitem" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "slot" | "script" | "section" | "select" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "template" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | FunctionComponent<any> | "text" | "circle" | "view" | "pattern" | ComponentClass<any, any> | "animate" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "textPath" | "tspan" | "use" | "noindex" | "animateMotion" | "animateTransform" | "mpath"; rest: rest; sanitize: (str: string) => string; searchWords: (string | RegExp)[]; textToHighlight: string; unhighlightClassName: string; unhighlightStyle: CSSProperties }
      • activeClassName: string
      • activeIndex: number
      • activeStyle: CSSProperties
      • autoEscape: boolean
      • caseSensitive: boolean
      • className: string
      • findChunks: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]
      • highlightClassName: string | {}
      • highlightStyle: CSSProperties
      • highlightTag: "symbol" | "object" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "big" | "blockquote" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "keygen" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "menu" | "menuitem" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "param" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "slot" | "script" | "section" | "select" | "small" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "template" | "tbody" | "td" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "webview" | FunctionComponent<any> | "text" | "circle" | "view" | "pattern" | ComponentClass<any, any> | "animate" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "path" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "textPath" | "tspan" | "use" | "noindex" | "animateMotion" | "animateTransform" | "mpath"
      • rest: rest
      • sanitize: (str: string) => string
          • (str: string): string
          • Parameters

            • str: string

            Returns string

      • searchWords: (string | RegExp)[]
      • textToHighlight: string
      • unhighlightClassName: string
      • unhighlightStyle: CSSProperties

    Returns Element

Const TimePicker

  • TimePicker(): { date: string; dateErrorPop: string; end: string; endTime: string; month: string; quarter: string; range: string; start: string; startTime: string; time: string; timeErrorPop: string; to: string; week: string; year: string; current: object; panel: object }
  • TimePicker(props: ITimePickerProps & { children?: ReactNode }): Element
  • TimePicker(): { date: string; dateErrorPop: string; end: string; endTime: string; month: string; quarter: string; range: string; start: string; startTime: string; time: string; timeErrorPop: string; to: string; week: string; year: string; current: object; panel: object }
  • Returns { date: string; dateErrorPop: string; end: string; endTime: string; month: string; quarter: string; range: string; start: string; startTime: string; time: string; timeErrorPop: string; to: string; week: string; year: string; current: object; panel: object }

    • date: string
    • dateErrorPop: string
    • end: string
    • endTime: string
    • month: string
    • quarter: string
    • range: string
    • start: string
    • startTime: string
    • time: string
    • timeErrorPop: string
    • to: string
    • week: string
    • year: string
    • current: object
      • date: string
      • month: string
      • time: string
      • week: string
      • year: string
    • panel: object
      • dayNames: string[]
      • hour: string
      • hourSelect: string
      • minute: string
      • minuteSelect: string
      • monthNames: string[]
      • quarterNames: string[]
      • second: string
      • secondSelect: string
      • titleFormat: string
      • year: string
      • yearQuarterName: function
        • yearQuarterName(__namedParameters: { quarter: number; year: number }): string
  • Parameters

    • props: ITimePickerProps & { children?: ReactNode }

    Returns Element

  • Returns { date: string; dateErrorPop: string; end: string; endTime: string; month: string; quarter: string; range: string; start: string; startTime: string; time: string; timeErrorPop: string; to: string; week: string; year: string; current: object; panel: object }

    • date: string
    • dateErrorPop: string
    • end: string
    • endTime: string
    • month: string
    • quarter: string
    • range: string
    • start: string
    • startTime: string
    • time: string
    • timeErrorPop: string
    • to: string
    • week: string
    • year: string
    • current: object
      • date: string
      • month: string
      • time: string
      • week: string
      • year: string
    • panel: object
      • dayNames: string[]
      • hour: string
      • hourSelect: string
      • minute: string
      • minuteSelect: string
      • monthNames: string[]
      • quarterNames: string[]
      • second: string
      • secondSelect: string
      • titleFormat: string
      • year: string
      • yearQuarterName: function
        • yearQuarterName(__namedParameters: { quarter: number; year: number }): string

Const TimePickerBase

  • TimePickerBase(__namedParameters: { ContentComponent: ComponentClass<ITimePanelProps<string>, any> | FunctionComponent<ITimePanelProps<string>>; autoComplete: boolean; className: string; defaultTime: string; disabled: boolean; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; onChange: (date: T) => void; onClose: () => void; onOpen: () => void; restProps: restProps; selectedDate: Date; value: string }): Element

Const TimePickerBody

  • TimePickerBody(__namedParameters: { defaultTime: string; disabledTimeOption: IDisabledTimeOption; format: string; hourStep: number; minuteStep: number; onSelected: (val: T, status?: boolean) => void; secondStep: number; selected: string }): Element
  • Parameters

    • __namedParameters: { defaultTime: string; disabledTimeOption: IDisabledTimeOption; format: string; hourStep: number; minuteStep: number; onSelected: (val: T, status?: boolean) => void; secondStep: number; selected: string }
      • defaultTime: string
      • disabledTimeOption: IDisabledTimeOption
      • format: string
      • hourStep: number
      • minuteStep: number
      • onSelected: (val: T, status?: boolean) => void
          • (val: T, status?: boolean): void
          • Parameters

            • val: T
            • Optional status: boolean

            Returns void

      • secondStep: number
      • selected: string

    Returns Element

Const TimePickerFooter

  • TimePickerFooter(__namedParameters: { format: string; onSelected: (val: T, status?: boolean) => void; selected: string }): Element
  • Parameters

    • __namedParameters: { format: string; onSelected: (val: T, status?: boolean) => void; selected: string }
      • format: string
      • onSelected: (val: T, status?: boolean) => void
          • (val: T, status?: boolean): void
          • Parameters

            • val: T
            • Optional status: boolean

            Returns void

      • selected: string

    Returns Element

Const TimePickerPanel

  • TimePickerPanel(__namedParameters: { hideFooter: boolean; restprops: restprops }): Element

Const TimeRangePicker

Const TimeRangePickerBase

  • TimeRangePickerBase(__namedParameters: { PickerComponent: ComponentClass<ITimePickerProps, any> | FunctionComponent<ITimePickerProps>; className: string; defaultTime: [string, string]; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; name: [string, string]; onChange: (date: T) => void; onClose: (type?: RangeType) => void; onOpen: (type?: RangeType) => void; placeholder: [string, string]; restProps: restProps; seperator: string; value: [string, string] }): Element
  • Parameters

    • __namedParameters: { PickerComponent: ComponentClass<ITimePickerProps, any> | FunctionComponent<ITimePickerProps>; className: string; defaultTime: [string, string]; disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; name: [string, string]; onChange: (date: T) => void; onClose: (type?: RangeType) => void; onOpen: (type?: RangeType) => void; placeholder: [string, string]; restProps: restProps; seperator: string; value: [string, string] }
      • PickerComponent: ComponentClass<ITimePickerProps, any> | FunctionComponent<ITimePickerProps>
      • className: string
      • defaultTime: [string, string]
      • disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption
      • name: [string, string]
      • onChange: (date: T) => void
          • (date: T): void
          • Parameters

            • date: T

            Returns void

      • onClose: (type?: RangeType) => void
      • onOpen: (type?: RangeType) => void
      • placeholder: [string, string]
      • restProps: restProps
      • seperator: string
      • value: [string, string]

    Returns Element

Const TimeUnitColumn

  • TimeUnitColumn(__namedParameters: { disabledUnits: number[]; selected: number; setting: (val: number) => void; step: number; type: "hour" | "minute" | "second" }): Element
  • Parameters

    • __namedParameters: { disabledUnits: number[]; selected: number; setting: (val: number) => void; step: number; type: "hour" | "minute" | "second" }
      • disabledUnits: number[]
      • selected: number
      • setting: (val: number) => void
          • (val: number): void
          • Parameters

            • val: number

            Returns void

      • step: number
      • type: "hour" | "minute" | "second"

    Returns Element

Const TimelineDot

  • TimelineDot(__namedParameters: { color: string; props: props }): Element

Const TimelineItemOptionalPop

  • TimelineItemOptionalPop(__namedParameters: { children: any; popoverRef: any; position: any; tip: any }): any
  • Parameters

    • __namedParameters: { children: any; popoverRef: any; position: any; tip: any }
      • children: any
      • popoverRef: any
      • position: any
      • tip: any

    Returns any

Const Title

  • Title(__namedParameters: { onClick: () => void; text: string | number; unit: string }): Element

Const TopCenter

  • TopCenter(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • popover
    anchor

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const TopLeft

  • TopLeft(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • popover
    anchor

    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const TopLeftInViewport

  • TopLeftInViewport(__namedParameters: { anchorRect: DOMRect | ClientRect; contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }

  • popoverpopoverpopover
    anchor
    ----------------

    Parameters

    • __namedParameters: { anchorRect: DOMRect | ClientRect; contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • anchorRect: DOMRect | ClientRect
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const TopRight

  • TopRight(__namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }): { className: string; style: object }
  •    ---------
       |popover|

    | anchor | | |


    Parameters

    • __namedParameters: { contentRect: DOMRect | ClientRect; cushion: number; relativeRect: ClientRect }
      • contentRect: DOMRect | ClientRect
      • cushion: number
      • relativeRect: ClientRect

    Returns { className: string; style: object }

    • className: string
    • style: object
      • left: number
      • position: "absolute"
      • top: number

Const TransferItem

  • TransferItem(__namedParameters: { compontentDisabled: boolean; dataSets: ITransferData[]; filterOption: (inputValue: string, option: ITransferData) => boolean; handleSelectChange: (keys: string[]) => void; keyName: string; list: {} & { columns: TransferColumnType }; pagination: false | true | { pageSize: number }; prefix: string; searchPlaceholder: string; selectedKeys: string[]; showSearch: boolean; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { compontentDisabled: boolean; dataSets: ITransferData[]; filterOption: (inputValue: string, option: ITransferData) => boolean; handleSelectChange: (keys: string[]) => void; keyName: string; list: {} & { columns: TransferColumnType }; pagination: false | true | { pageSize: number }; prefix: string; searchPlaceholder: string; selectedKeys: string[]; showSearch: boolean; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • compontentDisabled: boolean
      • dataSets: ITransferData[]
      • filterOption: (inputValue: string, option: ITransferData) => boolean
      • handleSelectChange: (keys: string[]) => void
          • (keys: string[]): void
          • Parameters

            • keys: string[]

            Returns void

      • keyName: string
      • list: {} & { columns: TransferColumnType }
      • pagination: false | true | { pageSize: number }
      • prefix: string
      • searchPlaceholder: string
      • selectedKeys: string[]
      • showSearch: boolean
      • title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

Const TriggerDiv

  • TriggerDiv(__namedParameters: { canClear: boolean; children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; disabled: boolean; panelVisible: boolean; width: string | number }): Element
  • Parameters

    • __namedParameters: { canClear: boolean; children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; disabled: boolean; panelVisible: boolean; width: string | number }
      • canClear: boolean
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • disabled: boolean
      • panelVisible: boolean
      • width: string | number

    Returns Element

Const WeekPicker

Const WeekPickerPanel

  • WeekPickerPanel(__namedParameters: { hoverDate: Date; restProps: restProps; selected: Date; weekStartsOn: WeekStartsOnMap }): Element

WindowEventHandler

  • WindowEventHandler<K>(__namedParameters: { eventName: K; listener: listener; options: AddEventListenerOptions }): Element

Const WindowResizeHandler

  • WindowResizeHandler(__namedParameters: { disableThrottle: boolean; onResizeProp: onResize }): Element
  • Register a resize event on Window

    The event handler got a second parameter: {deltaX, deltaY}. The onResize callback is throttled to run only once in a frame, you don't need to throttle the callback.

    Parameters

    • __namedParameters: { disableThrottle: boolean; onResizeProp: onResize }
      • disableThrottle: boolean
      • onResizeProp: onResize

    Returns Element

Const WindowScrollHandler

  • WindowScrollHandler(__namedParameters: { disableThrottle: boolean; onScrollProp: (event: UIEvent) => void; options: AddEventListenerOptions }): Element

Const YearPicker

Const YearPickerBody

  • YearPickerBody(__namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; firstYear: number; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }): Element
  • Parameters

    • __namedParameters: { col: number; defaultPanelDate: Date; disabledPanelDate: (val: Date) => boolean; firstYear: number; onSelected: (val: Date, status?: boolean) => void; row: number; selected: Date }
      • col: number
      • defaultPanelDate: Date
      • disabledPanelDate: (val: Date) => boolean
          • (val: Date): boolean
          • Parameters

            • val: Date

            Returns boolean

      • firstYear: number
      • onSelected: (val: Date, status?: boolean) => void
          • (val: Date, status?: boolean): void
          • Parameters

            • val: Date
            • Optional status: boolean

            Returns void

      • row: number
      • selected: Date

    Returns Element

Const YearPickerPanel

  • YearPickerPanel(props: {} & { children?: ReactNode }): Element

YouzanIcon

  • YouzanIcon(__namedParameters: { colorPreset: "primary" | "grey"; size: number; text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; textPosition: "left" | "top" | "right" | "bottom" }): Element
  • Parameters

    • __namedParameters: { colorPreset: "primary" | "grey"; size: number; text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; textPosition: "left" | "top" | "right" | "bottom" }
      • colorPreset: "primary" | "grey"
      • size: number
      • text: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • textPosition: "left" | "top" | "right" | "bottom"

    Returns Element

YouzanSvg

  • YouzanSvg(__namedParameters: { size: number }): Element

_destroy

  • _destroy(ta: HTMLTextAreaElement): void

_update

  • _update(ta: HTMLTextAreaElement): void

addDialogInstance

addEventListener

  • addEventListener<T>(target: T, eventName: string, listener: EventListener, options?: AddEventListenerOptions): unsubscribe

alert

applyHeight

  • applyHeight(el: HTMLDivElement, height: number | string): void

array

assign

  • assign(ta: HTMLTextAreaElement): void

Const autoprefix

  • autoprefix(elements: any): {}

autosize

  • autosize(el: HTMLTextAreaElement): HTMLTextAreaElement
  • autosize(el: NodeListOf<HTMLTextAreaElement>): NodeListOf<HTMLTextAreaElement>

calculateChange

  • calculateChange(e: any, skip: any, props: any, container: HTMLElement): { a: any; h: any; l: any; s: any; source: string }

calculateLimit

  • calculateLimit(value: number | null, min: number, max: number): { canDec: boolean; canInc: boolean }

calculateTime

capitalize

  • capitalize(val: string): string

caselessMatchFilterOption

  • caselessMatchFilterOption(searchText: string, item: ISelectMenuItem): boolean

catchError

checkProps

clear

  • clear(containerId: any): void

clone

cloneChildren

  • cloneChildren(children: ReactNode): ReactNode[]

Const closeAllNotify

  • closeAllNotify(): void

closeDialog

Const closeNotify

  • closeNotify(containerId: any): void

Const closeNotifyCallback

  • closeNotifyCallback(callback: any): void

cmp

  • cmp(a: number, b: number): number

combineChunks

commonTransformTabData

  • commonTransformTabData<Id>(tabItem: IInnerTab<Id>, candel: boolean): { actived: boolean; candel: boolean; className: string; disabled: boolean; key: Id; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
  • Type parameters

    • Id

    Parameters

    Returns { actived: boolean; candel: boolean; className: string; disabled: boolean; key: Id; title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }

    • actived: boolean
    • candel: boolean
    • className: string
    • disabled: boolean
    • key: Id
    • title: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

compose

  • compose<Target>(...middlewares: Middleware<Target>[]): (Anonymous function)
  • example middleware

    ```tsx function when(condition: () => boolean | Promise): Middleware<IValidator> { return (next: IValidator) => createAsyncValidator((value, ctx) => { return of(condition()).pipe( switchMap(cond => { if (cond) { return isAsyncValidator(next) ? next.validator(value, ctx) ?? of(null) : of(next(value, ctx)); } return of(null); }), ); }); } }

    const validator = compose(when(() => Math.random() > 0.5))(required('required if random number great then 5'));

    Type parameters

    • Target

    Parameters

    Returns (Anonymous function)

computeOffsetPixels

  • computeOffsetPixels(offset: string | number, contextHeight: number): number

computedStyle

  • computedStyle(el: Element, prop: string): string

config

  • config(options: any): void

confirm

containsCJK

  • containsCJK(str: string): boolean

containsEmoji

  • containsEmoji(str: string): boolean

convertHexToDecimal

  • convertHexToDecimal(h: string): number

copy

  • copy(text: string): boolean

correctMark

createArrowPosition

createAsyncValidator

createContainer

Const createContainerId

  • createContainerId(): number

createContainerNode

  • createContainerNode(parent: Node, tag?: string): HTMLElement

createDateRangeWithSingleDate

createElement

  • createElement<K>(tagName: K, options?: ElementCreationOptions): HTMLElementTagNameMap[K]
  • createElement<K>(tagName: K, options?: ElementCreationOptions): HTMLElementDeprecatedTagNameMap[K]
  • createElement(tagName: string, options?: ElementCreationOptions): HTMLElement

Const createEvent

  • createEvent(name: string): Event

createMediaQueryDispatcher

Const createModelNotFoundError

createNode

Const createNotifyContainerNode

  • createNotifyContainerNode(): HTMLElement

createObjectURL

  • createObjectURL<T>(object: T): any

createPromiseQueue

  • createPromiseQueue<T>(items: T[], pGenerator: (item: T) => Promise<void>): (Anonymous function)
  • Type parameters

    • T

    Parameters

    • items: T[]
    • pGenerator: (item: T) => Promise<void>
        • (item: T): Promise<void>
        • Parameters

          • item: T

          Returns Promise<void>

    Returns (Anonymous function)

createStateByProps

  • createStateByProps(__namedParameters: { checkable: boolean; checkedKeys: (string | number)[]; data: ITreeData[]; dataType: "tree" | "plain"; disabledCheckedKeys: (string | number)[]; expandAll: boolean; isRoot: (data: ITreeData) => boolean; loadMore: (data: ITreeData) => Promise<any>; propsRenderKey: {} }): ICreateStateByPropsReturn

Const createUnexpectedModelError

Const createUnexpectedModelTypeError

  • createUnexpectedModelTypeError(name: string, expectedType: string, model: IModel<unknown>): FormulrError

Const createUploadItemId

  • createUploadItemId(): string

createUseIMEComposition

dangerousStyleValue

  • dangerousStyleValue(name: string, value: unknown, isCustomProperty?: boolean): string
  • Convert a value into the proper css writable value. The style name name should be logical (no hyphens), as specified in CSSProperty.isUnitlessNumber.

    Parameters

    • name: string

      CSS property name such as topMargin.

    • value: unknown

      CSS property value such as 10px.

    • Optional isCustomProperty: boolean

    Returns string

    Normalized style value with dimensions applied.

dateDefaultTimeFactory

  • dateDefaultTimeFactory(): string

dateDefaultValueFactory

dateRangeDefaultTimeFactory

  • dateRangeDefaultTimeFactory(): []

dateRangeDefaultValueFactory

debounce

  • Returns a function, that, as long as it continues to be invoked, will not be triggered. The function will be called after it stops being called for wait milliseconds

    Type parameters

    • T: (...args: any) => any

    Parameters

    • func: T
    • Default value wait: number = 0
    • Default value options: IDebounceOptions = {}

    Returns T & ICancelable

default

  • default<F>(resultFn: F, isEqual?: EqualityFn): F

Const defaultFilter

Const defaultFindChunks

  • defaultFindChunks(__namedParameters: { autoEscape: boolean; caseSensitive: boolean; sanitize: (str: string) => string; searchWords: (string | RegExp)[]; textToHighlight: string }): any[]
  • Examine text for any matches. If we find matches, add them to the returned array as a "chunk" object.

    Parameters

    • __namedParameters: { autoEscape: boolean; caseSensitive: boolean; sanitize: (str: string) => string; searchWords: (string | RegExp)[]; textToHighlight: string }
      • autoEscape: boolean
      • caseSensitive: boolean
      • sanitize: (str: string) => string
          • (str: string): string
          • Parameters

            • str: string

            Returns string

      • searchWords: (string | RegExp)[]
      • textToHighlight: string

    Returns any[]

Const defaultFormat

  • defaultFormat(percent: number): string

defaultGetItemTooltip

defaultGetThumbSrcFromFile

  • defaultGetThumbSrcFromFile(file: File): Promise<string>

defaultGetValidateOption

Const defaultHighlight

  • defaultHighlight(keyword: string, path: ICascaderItem[]): React.ReactNode

defaultIsEqual

  • defaultIsEqual<Key, Item>(a: Item, b: Item): boolean

defaultIsValidNewOption

  • defaultIsValidNewOption<Key>(keyword: string, options: ISelectItem<Key>[]): boolean

defaultPreview

defaultRenderError

  • defaultRenderError<T>(error: IMaybeError<T>): Element

defaultRenderItemContent

Const defaultRenderNextArrow

  • defaultRenderNextArrow(onNext: () => void): Element

defaultRenderOptionList

  • defaultRenderOptionList<Key, Item>(options: Item[], renderOption: IOptionRenderer<Key, Item>): (string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal)[]
  • Type parameters

    Parameters

    Returns (string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal)[]

Const defaultRenderPrevArrow

  • defaultRenderPrevArrow(onPrev: () => void): Element

Const defaultSanitize

  • defaultSanitize(str: string): string

defer

  • defer(callback: (...args: any[]) => void, ...cbArgs: any[]): ICancelable

destroy

  • destroy(el: HTMLTextAreaElement): HTMLTextAreaElement
  • destroy(el: NodeListOf<HTMLTextAreaElement>): NodeListOf<HTMLTextAreaElement>

diffStyle

  • diffStyle(prev: CSSProperties, next: CSSProperties): CSSProperties

difference

Const disabledDateWithRange

Const disabledTimeWithMax

Const disabledTimeWithMin

Const disabledTimeWithRange

ease

  • ease(k: number): number

email

ensureCanMutateNextEventHandlers

  • ensureCanMutateNextEventHandlers(eventHandlers: IEventHandlers): void

ensureRefIsUsedByChild

  • ensureRefIsUsedByChild(children: any, ref: any): void

ensureUniqDialogInstance

  • ensureUniqDialogInstance(dialogId: string): void

equal

  • equal<T>(a: T[], b: T[]): boolean

error

  • error(text: any, duration?: number, callback?: () => void): number

escapeRegExpFn

  • escapeRegExpFn(str: string): string

eventOptionsKey

  • eventOptionsKey(normalizedEventOptions: boolean | AddEventListenerOptions): number

execPromiseQueue

  • execPromiseQueue<T>(items: T[], pGenerator: (item: T) => Promise<void>): Promise<void>
  • Type parameters

    • T

    Parameters

    • items: T[]
    • pGenerator: (item: T) => Promise<void>
        • (item: T): Promise<void>
        • Parameters

          • item: T

          Returns Promise<void>

    Returns Promise<void>

exposePopover

  • exposePopover<N>(propName: N): expose

field

fillInChunks

filterExpandNode

filterReviver

  • filterReviver<Key, Item>(value: Item[] | Item | null): Item | Item[]

finalizeWithLast

  • finalizeWithLast<T>(callback: (value: T) => void, defaultValue: T): finalizeWithLastOperatorFunction

findAll

  • findAll(__namedParameters: { autoEscape: boolean; caseSensitive: boolean; findChunks: (options: Omit<ITextMarkFindAllParameters, "findChunks">) => ITextMarkChunk[]; sanitize: (str: string) => string; searchWords: (string | RegExp)[]; textToHighlight: string }): ITextMarkChunk[]

findIndex

  • findIndex<T>(array: ArrayLike<T> | null | undefined, predicate: ListIterator<T, boolean>, fromIndex?: number): number

findLastIndex

  • findLastIndex<T>(array: ArrayLike<T> | null | undefined, predicate: ListIterator<T, boolean>, fromIndex?: number): number

findMentionAtCaretPosition

findNextSelectableOption

  • findNextSelectableOption<Key, Item>(options: Item[], start: number): number | null

findPositionedParent

  • findPositionedParent(elem: Element, inclusive?: boolean): Element | null
  • Find the first positioned ancestor up in the DOM tree.

    Parameters

    • elem: Element

      dom element to search from

    • Default value inclusive: boolean = false

      true if elem is considered an ancestor of itself

    Returns Element | null

    the first positioned ancestor node

findPrevSelectableOption

  • findPrevSelectableOption<Key, Item>(options: Item[], start: number): number

findSubscriberIndex

  • findSubscriberIndex(config: any): number

fitText

  • fitText(containerNode: HTMLSpanElement | null, textNode: HTMLSpanElement | null): number

fixLeftEdgeCase

  • fixLeftEdgeCase(layout: PaginationLayout[], current: number): ({ disabled: boolean; type: "left-arrow" } | { disabled: boolean; type: "right-arrow" } | { page: number; selected: boolean; type: "number" } | { type: "double-left-arrow" } | { type: "double-right-arrow" } | { totalPages: number; type: "mini-jumper" })[]
  • Parameters

    Returns ({ disabled: boolean; type: "left-arrow" } | { disabled: boolean; type: "right-arrow" } | { page: number; selected: boolean; type: "number" } | { type: "double-left-arrow" } | { type: "double-right-arrow" } | { totalPages: number; type: "mini-jumper" })[]

fixRightEdgeCase

  • fixRightEdgeCase(layout: PaginationLayout[], current: number): ({ disabled: boolean; type: "left-arrow" } | { disabled: boolean; type: "right-arrow" } | { page: number; selected: boolean; type: "number" } | { type: "double-left-arrow" } | { type: "double-right-arrow" } | { totalPages: number; type: "mini-jumper" })[]
  • Parameters

    Returns ({ disabled: boolean; type: "left-arrow" } | { disabled: boolean; type: "right-arrow" } | { page: number; selected: boolean; type: "number" } | { type: "double-left-arrow" } | { type: "double-right-arrow" } | { totalPages: number; type: "mini-jumper" })[]

Const flattenNames

  • flattenNames(things?: any[]): any[]

focusWithoutScroll

  • focusWithoutScroll(node: HTMLElement): void

form

  • form<ChildBuilders>(childBuilders: ChildBuilders): FormBuilder<ChildBuilders>

formReducer

format

formatDate

  • formatDate(date: string | Date | number, mask?: string, locale?: IFechaI18nSettings): string
  • 格式化一个 date 对象

    memberof

    module:date

    example

    formatDate('2017-06-06T09:37:16.437Z'); // '周二 6月 06 2017 17:37:16' formatDate('2017-06-06T09:37:16.437Z', 'YYYY-MM-DD'); // '2017-06-06' formatDate(new Date(), 'YYYY-MM-DD'); // '2017-06-06' formatDate(1496800160058, 'YYYY-MM-DD'); // '2017-06-07'

    Parameters

    • date: string | Date | number

      The date to format

    • Default value mask: string = "default"

      解析的格式,默认为 'default'

    • Default value locale: IFechaI18nSettings = zhCN

      i18n 的设置,默认为 zhCN

    Returns string

    date 对象

formatDateRange

  • formatDateRange(dates: [], format: string): []

Const formatEndDate

  • formatEndDate(format: string): string

formatFileSize

  • formatFileSize(size: number): string

Const formatStartDate

  • formatStartDate(format: string): string

formatText

  • formatText(selected: Date | null, format: string): string

formatTextRange

fromPotential

  • fromPotential(v: number | string | undefined): Decimal | null

generateUnits

  • generateUnits(start: number, end: number, step: number, disabledUnits: number[]): IUnit[]

get

  • get(c1: any, c2: any, size: any, serverCanvas: any): any

getActiveValue

getCallbackValueRangeWithDate

getCallbackValueWithDate

getCaretCoordinates

  • getCaretCoordinates(element: HTMLInputElement | HTMLTextAreaElement, position: number, __namedParameters: { debug: boolean }): { height: number; left: number; top: number }
  • Parameters

    • element: HTMLInputElement | HTMLTextAreaElement
    • position: number
    • __namedParameters: { debug: boolean }
      • debug: boolean

    Returns { height: number; left: number; top: number }

    • height: number
    • left: number
    • top: number

Const getCellClassName

  • getCellClassName(__namedParameters: { isCurrent: boolean; isDisabled: boolean; isInHoverRange: boolean; isInRange: boolean; isInView: boolean; isSelected: boolean }): string
  • Parameters

    • __namedParameters: { isCurrent: boolean; isDisabled: boolean; isInHoverRange: boolean; isInRange: boolean; isInView: boolean; isSelected: boolean }
      • isCurrent: boolean
      • isDisabled: boolean
      • isInHoverRange: boolean
      • isInRange: boolean
      • isInView: boolean
      • isSelected: boolean

    Returns string

getCompatSelectionPropsFn

  • getCompatSelectionPropsFn<Data>(selection?: IGridSelection<Data>): IGridSelection["getSelectionProps"] | undefined

getComponentStack

  • getComponentStack(info: any): any

getContainer

getCurrentPosition

Const getDecimal

  • getDecimal(step: number | string): number

getDelta

  • getDelta(step?: number): number

getDisabled

Const getDisabledDateAndTimeWithRangeProps

Const getDisabledKeys

  • getDisabledKeys(dataSource: ITransferData[], keyName: string): any[]

getExtraStyle

  • getExtraStyle(__namedParameters: { depth: any; inlineIndent: any; isInline: any }): CSSProperties
  • Parameters

    • __namedParameters: { depth: any; inlineIndent: any; isInline: any }
      • depth: any
      • inlineIndent: any
      • isInline: any

    Returns CSSProperties

getFieldSetChildChangeObservable

  • getFieldSetChildChangeObservable(fieldSet: FieldSetModel, name: string): Observable<string>
  • Because FieldSetModel.prototype.registerChild will be called inside useMemo, consume at next micro task queue to avoid react warning below.

    Cannot update a component from inside the function body of a different component.

    Parameters

    Returns Observable<string>

Const getFileIcon

getFromPath

  • getFromPath(obj: Record<string | number, any>, path?: string | string[], defaultValue?: unknown): unknown
  • Like _.get, but only supports objects! You don't need this function 99% of the time.

    Parameters

    • obj: Record<string | number, any>
    • Optional path: string | string[]
    • Optional defaultValue: unknown

    Returns unknown

getHeight

  • getHeight(): number

getInputNodeForTrigger

  • getInputNodeForTrigger(node: Element | Text | null): HTMLInputElement | HTMLTextAreaElement | null

getJudgeInfo

getKeyFromChildrenIndex

  • getKeyFromChildrenIndex(child: any, index: any, subPrefix?: string): any

getLeafColumns

Const getLeft

  • getLeft(value: number, min: number, max: number): number

getLineHeight

  • getLineHeight(node: HTMLElement, chars?: string): number

getLocale

getMax

  • getMax(max: number | undefined): number

getMenuListItems

  • getMenuListItems(suggestions: any, notFoundContent: any): any

getMin

  • getMin(min: number | undefined): number

getNode

getNodeChildren

getNodeDepth

getNodeFromSelector

  • getNodeFromSelector(selector: string | Element): Element

getNodeKey

Const getOppositeDirection

getPageRange

getPanelCellsData

  • getPanelCellsData(__namedParameters: { col: number; dateConfig: IGenerateDateConfig; defaultPanelDate: Date; disableRangeOverView: boolean; disabledPanelDate: (date: Date) => boolean; hoverRangeDate: [Date, Date]; inView: (val1: Date, val2: Date) => boolean; offset: number; rangeDate: [Date, Date]; row: number; selected: Date; texts: (string | number)[] }): IDateCellBase[]
  • 根据当前组件的selected等值 获得最小单元格的属性集合

    Parameters

    • __namedParameters: { col: number; dateConfig: IGenerateDateConfig; defaultPanelDate: Date; disableRangeOverView: boolean; disabledPanelDate: (date: Date) => boolean; hoverRangeDate: [Date, Date]; inView: (val1: Date, val2: Date) => boolean; offset: number; rangeDate: [Date, Date]; row: number; selected: Date; texts: (string | number)[] }
      • col: number
      • dateConfig: IGenerateDateConfig
      • defaultPanelDate: Date
      • disableRangeOverView: boolean
      • disabledPanelDate: (date: Date) => boolean
          • (date: Date): boolean
          • Parameters

            • date: Date

            Returns boolean

      • hoverRangeDate: [Date, Date]
      • inView: (val1: Date, val2: Date) => boolean
          • (val1: Date, val2: Date): boolean
          • Parameters

            • val1: Date
            • val2: Date

            Returns boolean

      • offset: number
      • rangeDate: [Date, Date]
      • row: number
      • selected: Date
      • texts: (string | number)[]

    Returns IDateCellBase[]

Const getPathLabel

getPathToNode

Const getPathValue

Const getPopoverBottomPosition

Const getPopoverTopPosition

Const getPosition

  • getPosition(__namedParameters: { cushion: number; placement: IPositionFunction; popover: Popover; visible: boolean }, getContainer: () => Element | null, getPositionedParent: () => Element | null, portalRef: RefObject<IPortalImperativeHandlers>): IPopoverPosition
  • getPosition(value: number, min: number, max: number): string

getPotentialValues

  • getPotentialValues(marks: Record<string | number, React.ReactNode> | undefined): number[]

getRadioState

getRangeValuesWithValueType

getReadOnly

getRenderChildrenFromProps

  • getRenderChildrenFromProps(children: ReactNode): { items: any[]; preChildren: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; renderItems: (string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal)[] }
  • 根据props的children,获取有效的渲染节点

    Parameters

    • children: ReactNode

      props的子节点

    Returns { items: any[]; preChildren: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; renderItems: (string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal)[] }

    • items: any[]
    • preChildren: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
    • renderItems: (string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal)[]

Const getRowCheckedState

getScrollPosition

  • getScrollPosition(): { x: any; y: any }

getScrollbarWidth

  • getScrollbarWidth(): number

getSelectedPaths

getSelectedValueWithDate

Const getSingleDirectionSelectedKeysExcludeDisabled

  • getSingleDirectionSelectedKeysExcludeDisabled(__namedParameters: { direction: Direction; disabledKeys: string[]; selectedKeys: string[]; targetKeys: string[] }): string[]
  • Parameters

    • __namedParameters: { direction: Direction; disabledKeys: string[]; selectedKeys: string[]; targetKeys: string[] }
      • direction: Direction
      • disabledKeys: string[]
      • selectedKeys: string[]
      • targetKeys: string[]

    Returns string[]

getStateFromProps

getTabDataFromChild

  • getTabDataFromChild<Id>(child: ReactElement<React.PropsWithChildren<ITabPanelProps<Id>>>, activeId: Id): IInnerTab<Id>

getTextPosition

getTipsContent

getToday

  • getToday(): number

getValidDate

  • getValidDate(date: unknown): Date
  • 将一个字符串、数字转化为 Date 的实例

    example

    let date = getValidDate(new Date()); date instanceof Date;// true date = getValidDate(1496800160058); date instanceof Date;// true

    Parameters

    • date: unknown

      需要转换的值

    Returns Date

    Date 的实例

getValidObservable

  • getValidObservable<T>(model: BasicModel<T>): BehaviorSubject<boolean>

getValidators

Const getValue

  • getValue(ratio: number, min: number, max: number): number

getValueForBreakpoint

getValueObservable

  • getValueObservable<T>(model: BasicModel<T>): BehaviorSubject<T>

getViewportHeight

  • getViewportHeight(): number

getViewportSize

  • getViewportSize(): { height: number; width: number }

getViewportWidth

  • getViewportWidth(): number

getVisible

getWidth

  • getWidth(): number

groupedColumns

handleClick

handleItemClick

  • handleItemClick(__namedParameters: { event: MouseEvent<HTMLLIElement, MouseEvent>; item: IMenuListItem; onRequestClose: () => void }): void

hasScrollbarY

  • hasScrollbarY(element: Element): boolean

hslToRgb

  • hslToRgb(h: number, s: number, l: number): { b: number; g: number; r: number }
  • Converts an HSL color value to RGB.

    Assumes: h is contained in [0, 1] or [0, 360] and s and l are contained [0, 1] or [0, 100] Returns: { r, g, b } in the set [0, 255]

    Parameters

    • h: number
    • s: number
    • l: number

    Returns { b: number; g: number; r: number }

    • b: number
    • g: number
    • r: number

hsvToRgb

  • hsvToRgb(h: number, s: number, v: number): { b: number; g: number; r: number }
  • Converts an HSV color value to RGB.

    Assumes: h is contained in [0, 1] or [0, 360] and s and v are contained in [0, 1] or [0, 100] Returns: { r, g, b } in the set [0, 255]

    Parameters

    • h: number
    • s: number
    • v: number

    Returns { b: number; g: number; r: number }

    • b: number
    • g: number
    • r: number

hyphenateStyleName

  • hyphenateStyleName(name: string): string

Const id

  • id<T>(it: T): T

identity

  • identity<T>(value: T | undefined): T | undefined

inferContentLineHeight

  • inferContentLineHeight(node: HTMLElement, str: string): number

Const info

  • info(text: any, duration?: number, callback?: () => void): number

Const initArray

  • initArray(targetNum: number): number[]
  • initArray(targetNum: number): number[]

Const initRangeArray

  • initRangeArray(start: number, end: number): number[]

initRemainArray

  • initRemainArray(targetNum: number, total: number): number[]

inputToRGB

  • inputToRGB(color: string | IRGB | IRGBA | IHSL | IHSLA | IHSV | IHSVA | any): { a: number; b: number; format: any; g: number; ok: boolean; r: number }
  • Given a string or object, convert that input to RGB

    Possible string inputs:

    "red"
    "#f00" or "f00"
    "#ff0000" or "ff0000"
    "#ff000000" or "ff000000"
    "rgb 255 0 0" or "rgb (255, 0, 0)"
    "rgb 1.0 0 0" or "rgb (1, 0, 0)"
    "rgba (255, 0, 0, 1)" or "rgba 255, 0, 0, 1"
    "rgba (1.0, 0, 0, 1)" or "rgba 1.0, 0, 0, 1"
    "hsl(0, 100%, 50%)" or "hsl 0 100% 50%"
    "hsla(0, 100%, 50%, 1)" or "hsla 0 100% 50%, 1"
    "hsv(0, 100%, 100%)" or "hsv 0 100% 100%"

    Parameters

    Returns { a: number; b: number; format: any; g: number; ok: boolean; r: number }

    • a: number
    • b: number
    • format: any
    • g: number
    • ok: boolean
    • r: number

insertPath

install

  • install(config: any): void

Const is

  • is(x: any, y: any): boolean

isActive

  • isActive(value: number, left: number, right: number): boolean

isAsyncValidator

isClassComponent

  • isClassComponent(component: any): boolean

isControlled

isDOMElement

  • isDOMElement(component: any): component is ReactElement

isDate

  • isDate(value?: any): value is Date

isDecimal

  • isDecimal(value: string): boolean

isElementInView

  • isElementInView(el: Element, offset?: number): boolean

isEmptyInputValue

  • isEmptyInputValue(value: any): boolean

isEqual

  • isEqual(value: any, other: any): boolean
  • This function is non-recursive, and handles cyclic values. It ignores symbol key properties in objects.

    Parameters

    • value: any
    • other: any

    Returns boolean

isFieldArrayModel

  • isFieldArrayModel<Item, Child>(maybeModel: any): maybeModel is FieldArrayModel<Item, Child>

isFieldModel

  • isFieldModel<T>(maybeModel: any): maybeModel is FieldModel<T>

isFieldSetModel

  • isFieldSetModel<Children>(maybeModel: any): maybeModel is FieldSetModel<Children>

isFormModel

  • isFormModel<Children>(maybeModel: any): maybeModel is FormModel<Children>

Const isInteger

  • isInteger(value: string | number): boolean

isLeftValue

  • isLeftValue(nextValue: number, value: []): boolean

isModel

  • isModel<T>(maybeModel: any): maybeModel is BasicModel<T>

isModelRef

  • isModelRef<T, P, M>(maybeModelRef: any): maybeModelRef is ModelRef<T, P, M>

isMultiple

isNil

  • isNil(value: any): value is null | undefined

isNodeList

  • isNodeList(el: HTMLTextAreaElement | NodeListOf<HTMLTextAreaElement>): el is NodeListOf<HTMLTextAreaElement>

isObject

  • isObject(value?: any): boolean

isOutside

isPanelActive

  • isPanelActive(activeKey: string | string[] | undefined, key: string | undefined): boolean

isPathEqual

isPlainObject

  • isPlainObject(value: unknown): value is Record<string, unknown>

isPotentialValue

  • isPotentialValue(value: string): boolean

isPromise

  • isPromise<T>(obj: any): obj is Promise<T>

isRequiredValidator

  • isRequiredValidator<T>(validator: IValidator<T>): boolean

isSelectable

  • isSelectable<Key, Item>(item: Item): boolean

isSingle

isSome

  • isSome<T>(maybe: Maybe<T>): maybe is ISome<T>

Const isStringOrNumber

  • isStringOrNumber(x: any): boolean

isValidCSSUnit

  • isValidCSSUnit(color: string | number): boolean

isValidDate

  • isValidDate(value: number | string): boolean

isValueFactory

  • isValueFactory<Value>(candidate: Value | (() => Value)): candidate is () => Value

isViewDrivenProps

isWhiteSpace

  • isWhiteSpace(c: any): boolean

kindOf

  • kindOf(MaybeDerive: any | string, Base: any): boolean

last

  • last<T>(arr: T[]): T

liteLayout

lowercaseProps

  • lowercaseProps(object: {}): {}

makeChangeHandler

  • makeChangeHandler<Value>(model: FieldModel<Value>, option?: number, callback?: (value: Value) => void): (Anonymous function)
  • 生成一个默认的onChange回调,这个回调会触发model.validate 如果不需要在onChange的时候触发校验,如下即可:

    const onChange = useCallback(value => model.value = value, [model]);

    例如是一个input

    const onChange = useCallback((value: React.ChangeEvent<HTMLInputElement>) => {
      model.value = e.target.value;
    }, [model]);

    可以配合usePipe使用:

    function mapEventToValue(e) {
      return e.target.value;
    }
    function Foo() {
      const onChange = FieldUtils.usePipe(
        mapEventToValue,
        FieldUtils.makeChangeHandler(model),
      );
    }

    Type parameters

    • Value

    Parameters

    • model: FieldModel<Value>
    • Default value option: number = ValidateOption.Default | ValidateOption.ExcludePristine
    • Optional callback: (value: Value) => void
        • (value: Value): void
        • Parameters

          • value: Value

          Returns void

    Returns (Anonymous function)

makeChildrenContext

makeDateStr

  • makeDateStr(date: string | Date | number, mask?: string): string
  • 获得 YYYY-MM-DD 格式的日期字符串的快捷方法

    memberof

    module:date

    example

    makeDateStr(new Date()); // '2017-06-06'

    Parameters

    • date: string | Date | number

      需要格式化的字符串,兼容字符串、数字和 Date 实例

    • Default value mask: string = "YYYY-MM-DD"

      解析的格式,默认为 'YYYY-MM-DD',方便日常开发

    Returns string

    格式化后的日期字符串

makeDateTimeStr

  • makeDateTimeStr(date: string | Date | number, mask?: string): string
  • 获得 YYYY-MM-DD HH:mm:ss 格式的日期字符串的快捷方法

    memberof

    module:date

    example

    makeDateTimeStr(new Date()); // '2017-06-06 17:37:16'

    Parameters

    • date: string | Date | number

      需要格式化的字符串,兼容字符串、数字和 Date 实例

    • Default value mask: string = "YYYY-MM-DD HH:mm:ss"

      解析的格式,默认为 'YYYY-MM-DD HH:mm:ss',方便日常开发

    Returns string

    格式化后的日期字符串

makeEvent

mapDOMNodes

  • mapDOMNodes<T, V>(nodes: NodeListOf<T>, callback: (val: T, idx: number) => V): V[]
  • Type parameters

    • T: Node

    • V

    Parameters

    • nodes: NodeListOf<T>
    • callback: (val: T, idx: number) => V
        • (val: T, idx: number): V
        • Parameters

          • val: T
          • idx: number

          Returns V

    Returns V[]

markForRequired

  • markForRequired<T>(validator: IValidator<T>): void

max

  • max(limit: number, message?: string): max

maxLength

measureScrollbar

  • measureScrollbar(): number

merge

Const mergeClasses

  • mergeClasses(classes: any, activeNames?: any[]): any

message

  • message<V>(messagenerator: (ctx: ValidatorContext<V>) => string): (Anonymous function)

min

  • min(limit: number | string, message?: string): min

minLength

miniLayout

monthUpdate

  • monthUpdate(arrName: string): (Anonymous function)

multi

  • multi<T, R>(...funcs: ((t: T) => R)[]): (t: T) => void

needFixBatchComps

  • needFixBatchComps(isTableInView: boolean, isHeaderInView: boolean, isFootInView: boolean): boolean

Const noop

  • noop(): void
  • noop(): void

normalLayout

normalize

  • normalize(timeline: any, size: any): any

normalizeEventOptions

  • normalizeEventOptions(eventOptions?: AddEventListenerOptions): boolean | AddEventListenerOptions

normalizeMinMax

normalizeToPotentialValue

  • normalizeToPotentialValue(potentialValues: number[], value: number): number

normalizeValue

  • normalizeValue(potential: number | undefined | null, min: number, max: number): { input: string; value: number | null }

omit

  • omit<T, K>(obj: T | null | undefined, paths: ReadonlyArray<K>): Omit<T, K>
  • Type parameters

    • T: Record<string, any>

    • K: keyof T

    Parameters

    • obj: T | null | undefined
    • paths: ReadonlyArray<K>

    Returns Omit<T, K>

onDocumentSelectionChange

  • onDocumentSelectionChange(evt: any): void

openDialog

or

  • or<T>(maybe: Maybe<T>, def: () => T): T

pad

  • pad(val: string | number, len?: number): string

parse

parseDate

  • parseDate(date: string | number | Date, mask?: string, locale?: IFechaI18nSettings): Date
  • 解析日期,字符串转化为日期

    memberof

    module:date

    see

    parse文档

    example

    parseDate('February 3rd, 2014', 'MMMM Do, YYYY'); // new Date(2014, 1, 3) parseDate('10-12-10 14:11:12', 'YY-MM-DD HH:mm:ss'); // new Date(2010, 11, 10, 14, 11, 12) parseDate('5/3/98', 'shortDate'); // new Date(1998, 4, 3) parseDate('November 4, 2005', 'longDate'); // new Date(2005, 10, 4)

    Parameters

    • date: string | number | Date

      需要解析的 date,默认应该传入字符串,但对下面两个情况也做了兼容:

      • 如果传入Date的实例则直接返回这个实例;
      • 如果传入时间戳数字,则返回 new Date(date) 函数调用后的值;
    • Default value mask: string = "default"

      解析的格式

    • Default value locale: IFechaI18nSettings = zhCN

      i18n 的设置,默认为 zhCN

    Returns Date

    转化后的日期

parseDateRange

parseIntFromHex

  • parseIntFromHex(val: string): number

parseOffsetAsPercentage

  • parseOffsetAsPercentage(str: string): number | undefined
  • Attempts to parse the offset provided as a prop as a percentage. For instance, if the component has been provided with the string "20%" as a value of one of the offset props. If the value matches, then it returns a numeric version of the prop. For instance, "20%" would become 0.2. If str isn't a percentage, then undefined will be returned.

    Parameters

    • str: string

      The value of an offset prop to be converted to a number.

    Returns number | undefined

    The numeric version of str. Undefined if str was not a percentage.

parseOffsetAsPixels

  • parseOffsetAsPixels(str: string | number): number | undefined
  • Attempts to parse the offset provided as a prop as a pixel value. If parsing fails, then undefined is returned. Three examples of values that will be successfully parsed are: 20 "20px" "20"

    Parameters

    • str: string | number

      A string of the form "{number}" or "{number}px", or just a number.

    Returns number | undefined

    The numeric version of str. Undefined if str was neither a number nor string ending in "px".

parseSelectedToRangeDate

patchElement

  • patchElement(parent: HTMLElement): void

Const patchUploadItemId

pattern

pick

  • pick<T, K>(obj: T | null | undefined, keys: ReadonlyArray<K>): Pick<T, K>
  • Type parameters

    • T: Record<string, any>

    • K: keyof T

    Parameters

    • obj: T | null | undefined
    • keys: ReadonlyArray<K>

    Returns Pick<T, K>

pickError

Const prefix

  • prefix(name: string): string

prefixKey

  • prefixKey(prefix: string, key: string): string
  • Parameters

    • prefix: string

      vendor-specific prefix, eg: Webkit

    • key: string

      style name, eg: transitionDuration

    Returns string

    style name prefixed with prefix, properly camelCased, eg: WebkitTransitionDuration

preventDefault

  • preventDefault(e: MouseEvent<HTMLElement>): void

preventOpenLink

  • preventOpenLink(event: MouseEvent<HTMLAnchorElement, MouseEvent>): void

previewImage

quarterFormatText

refArray

  • refArray(length: number): Array<RefObject<Star>>

regexEscape

  • regexEscape(str: string): string

remove

  • remove(id: number): void

removeAllChildren

  • removeAllChildren(node: Node): void

render

  • render(c1: any, c2: any, size: any, ServerCanvas: any): any

renderCheckboxGroup

Const renderCloseBtn

  • renderCloseBtn(closeBtn: React.ReactNode, onClose: () => void): Element

renderColorPicker

Const renderCompatibleChildren

  • renderCompatibleChildren(children: ReactElement, __namedParameters: { disabled: boolean; onMouseEnter: (event: MouseEvent<HTMLElement, MouseEvent>) => void; onMouseLeave: (event: MouseEvent<HTMLElement, MouseEvent>) => void }): Element
  • Why fixMouseEventsOnDisabledChildren? Mouse events don't trigger on disabled button https://github.com/youzan/zent/issues/142

    Workaround

    1. Wrap the disabled button/input in another element.
    2. Add {pointer-events: none} style to the disabled button/input.

    Parameters

    • children: ReactElement
    • __namedParameters: { disabled: boolean; onMouseEnter: (event: MouseEvent<HTMLElement, MouseEvent>) => void; onMouseLeave: (event: MouseEvent<HTMLElement, MouseEvent>) => void }
      • disabled: boolean
      • onMouseEnter: (event: MouseEvent<HTMLElement, MouseEvent>) => void
          • (event: MouseEvent<HTMLElement, MouseEvent>): void
          • Parameters

            • event: MouseEvent<HTMLElement, MouseEvent>

            Returns void

      • onMouseLeave: (event: MouseEvent<HTMLElement, MouseEvent>) => void
          • (event: MouseEvent<HTMLElement, MouseEvent>): void
          • Parameters

            • event: MouseEvent<HTMLElement, MouseEvent>

            Returns void

    Returns Element

Const renderFooter

  • renderFooter(footer: React.ReactNode): Element

Const renderHeader

  • renderHeader(title: React.ReactNode): Element

renderIcon

  • renderIcon(type: "info" | "success" | "warning" | "error" | undefined): Element

renderImageUpload

renderSelect

renderSingleUpload

renderSwitch

renderUpload

reorder

  • reorder<T>(array: T[], fromIndex: number, toIndex: number): any[]

replaceSubstring

  • replaceSubstring(str: any, start: any, end: any, replacer: any): { caret: number; value: string }

required

requiredTrue

restoreElement

  • restoreElement(parent: HTMLElement): void

reverse

  • reverse<T>(arr: T[]): T[]

reversePush

  • reversePush<T>(arr: T[], from: T[]): T[]

reviveSelectItem

  • reviveSelectItem<K>(reviver: K | { key: K } | ISelectItem<K>["reviver"]): ISelectItem<K>

rgbToHex

  • rgbToHex(r: number, g: number, b: number, allow3Char: boolean): string

rgbToHsl

  • rgbToHsl(r: number, g: number, b: number): { h: number; l: number; s: number }
  • Converts an RGB color value to HSL. Assumes: r, g, and b are contained in [0, 255] or [0, 1] Returns: { h, s, l } in [0,1]

    Parameters

    • r: number
    • g: number
    • b: number

    Returns { h: number; l: number; s: number }

    • h: number
    • l: number
    • s: number

rgbToHsv

  • rgbToHsv(r: number, g: number, b: number): { h: number; s: number; v: number }
  • Converts an RGB color value to HSV

    Assumes: r, g, and b are contained in the set [0, 255] or [0, 1] Returns: { h, s, v } in [0,1]

    Parameters

    • r: number
    • g: number
    • b: number

    Returns { h: number; s: number; v: number }

    • h: number
    • s: number
    • v: number

rgbToRgb

  • rgbToRgb(r: number, g: number, b: number): { b: number; g: number; r: number }

runInNextFrame

  • runInNextFrame(callback: () => void): () => void

runOnceInNextFrame

runValidator

sample

  • sample<T>(arr: ReadonlyArray<T>): T

scaleSvgSize

  • scaleSvgSize(size: number, value: number): number

scrollElement

  • scrollElement(this: HTMLElement, x: number, y: number): void

set

  • set<ChildBuilders>(childBuilders: ChildBuilders): FieldSetBuilder<ChildBuilders>

setDay

setHour

setLocale

setMinute

setMonth

setPm

setRowSpan

setSecond

setStyle

  • setStyle(target: any, styles: any): void

setValueForStyles

  • setValueForStyles(node: HTMLElement, styles: CSSProperties): void

Const shallowEqual

  • shallowEqual(newValue: unknown, oldValue: unknown): boolean
  • Performs equality by iterating through keys on an object and returning false when any key has values which are not strictly equal between the arguments. Returns true when the values of all keys are strictly equal.

    Parameters

    • newValue: unknown
    • oldValue: unknown

    Returns boolean

shorten

  • shorten(arr: string[], sLen: number): string[]

Const show

  • show(text: any, duration: any, status: any, callback: any): number
  • notify显示

    Parameters

    • text: any

      显示文案

    • duration: any

      显示时长

    • status: any

      notify状态

    • callback: any

      notify消失时回调

    Returns number

Const simpleIsEqual

  • simpleIsEqual(newArgs: unknown[], lastArgs: unknown[]): boolean

simplify

slice

  • slice(chars: string[], start: number, end: number): string

smoothScroll

  • smoothScroll(el: HTMLElement | Window, x: number, y: number, duration?: number): void
  • scrolls element with a smooth behavior

    method

    smoothScroll

    Parameters

    • el: HTMLElement | Window

      element to scroll

    • x: number

      target position x

    • y: number

      target position y

    • Default value duration: number = SCROLL_TIME

      animation duration

    Returns void

Const splitFileNameParts

  • splitFileNameParts(filename: string): string[]

step

stopPropagation

  • stopPropagation(e: MouseEvent): void

stringInputToObject

  • stringInputToObject(color: string): any

substring

  • substring(str: any, start: any, end: any): any

success

  • success(text: any, duration?: number, callback?: () => void): number

sweet

testPassiveEventListeners

  • testPassiveEventListeners(): boolean

throttle

tinycolor

Const toFixed

  • toFixed(value: number, fractionDigits: number): number

toggleLoading

  • toggleLoading(loading: string[], val: string, isLoading: boolean): string[]

toggleSelection

  • toggleSelection(): noop

translateToContainerCoordinates

  • translateToContainerCoordinates(containerRect: ClientRect | DOMRect, bb: ClientRect | DOMRect): ClientRect

trimLeadingPlus

  • trimLeadingPlus(value: string): string

typeOfModel

  • typeOfModel(model: any): "FieldModel" | "FieldArrayModel" | "FieldSetModel" | "FormModel" | "ModelRef" | "BasicModel" | "unknown"

unifiedDisabledDateFromProps

uninstall

  • uninstall(config: any): void

union

uniq

  • uniq<T>(array: ArrayLike<T> | null | undefined, iteratee?: ((value: T) => unknown) | string | number | symbol): T[]
  • Type parameters

    • T

    Parameters

    • array: ArrayLike<T> | null | undefined
    • Optional iteratee: ((value: T) => unknown) | string | number | symbol

    Returns T[]

Let uniqueId

  • uniqueId(prefix?: string): string

update

  • update(el: HTMLTextAreaElement): HTMLTextAreaElement
  • update(el: NodeListOf<HTMLTextAreaElement>): NodeListOf<HTMLTextAreaElement>

useAnimationFramed

  • useAnimationFramed(callback: () => void): (Anonymous function)

useArrayModel

useAsyncSafeDispatch

  • useAsyncSafeDispatch<Args>(dispatch: (...args: Args) => void): (Anonymous function)
  • 这个hook对React返回的状态更新函数(例 如useState、useReducer的返回值)包装 了一层,避免在异步回调中使用时导致可能的 内存泄漏(Async-Safe)

    Type parameters

    • Args: unknown[]

    Parameters

    • dispatch: (...args: Args) => void
        • (...args: Args): void
        • Parameters

          • Rest ...args: Args

          Returns void

    Returns (Anonymous function)

useCallbackRef

  • useCallbackRef<T>(callback: T): MutableRefObject<T>

useCombinedDisabledDate

useCompositionHandler

useConfirmStatus

  • useConfirmStatus(__namedParameters: { disabledTimeOption: IDisabledTimeOption; format: string; selected: string }): boolean

useDelayed

  • useDelayed(__namedParameters: { delay: number; loading: boolean }): boolean

useDestroyOnUnmount

Const useDrawerExiting

  • useDrawerExiting(visible: boolean): { exiting: boolean; onExited: (Anonymous function) }

useEffect$

  • useEffect$<T>(event$: Observable<T>, effect: (e: T) => void): void

useEventCallbackRef

  • useEventCallbackRef<T>(callback: T): MutableRefObject<T>

useEventHandler

  • useEventHandler<E, N, T>(target: T, eventName: N, listener: (event: E) => void, options?: AddEventListenerOptions): void

useField

useFieldArray

useFieldArrayValue

  • useFieldArrayValue<Item, Child>(field: string | FieldArrayModel<Item, Child>): Child[] | null

useFieldObservable

  • useFieldObservable<T, V>(field: IModel<T> | string, observable: (model: BasicModel<T>) => BehaviorSubject<V>): V

useFieldSet

useFieldSetModel

useFieldValid

  • useFieldValid<T>(field: string | IModel<T>): boolean | null

useFieldValue

  • useFieldValue<T>(field: string | IModel<T>): T | null

useForm

useFormChild

  • useFormChild<Value>(model: BasicModel<Value>, scrollAnchorRef?: RefObject<Element | null | undefined>): void
  • 将 model 关联到一个 DOM 节点,用于自定义 Field 滚动到错误位置的场景。

    Type parameters

    • Value

    Parameters

    • model: BasicModel<Value>

      需要关联 DOM 节点的 model 对象

    • Optional scrollAnchorRef: RefObject<Element | null | undefined>

      model 对象关联的 DOM 节点

    Returns void

useFormChildrenContext

useFormContext

useFormValid

  • useFormValid<T>(form: ZentForm<T>): boolean

useFormValue

useHover

  • useHover(initial?: boolean): { isHover: boolean; onMouseEnter: (Anonymous function); onMouseLeave: (Anonymous function) }
  • Parameters

    • Default value initial: boolean = false

    Returns { isHover: boolean; onMouseEnter: (Anonymous function); onMouseLeave: (Anonymous function) }

    • isHover: boolean
    • onMouseEnter: (Anonymous function)
    • onMouseLeave: (Anonymous function)

useHoverRange

  • useHoverRange(selected: DateNullTuple, hoverDate?: Date): [Date, Date]

useInitialValue

  • useInitialValue<T>(model: FieldModel<T>, initialValue?: T): void
  • 为 model 设置初始值,初始值会被作为 effect 的依赖,谨慎使用字面量

    Type parameters

    • T

    Parameters

    Returns void

useItemHandler

  • useItemHandler<UPLOAD_ITEM>(props: IUploadItemProps<UPLOAD_ITEM>): { deleteHandler: bivarianceHack; retryHandler: bivarianceHack }

useLazy

  • useLazy<T>(init: () => T, deps: any[]): () => T | null

useMAppend

  • useMAppend<T>(...fns: ((t: T) => void)[]): (t: T) => void
  • deprecated

    use useMulti instead

    const callback = useMAppend(foo, bar, baz)

    is equal to

    const callback = useCallback(arg => {
      foo(arg);
      bar(arg);
      baz(arg);
    }, [foo, bar, baz])

    Type parameters

    • T

    Parameters

    • Rest ...fns: ((t: T) => void)[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

useMergedProps

  • useMergedProps(__namedParameters: { defaultDate: string | number | Date; format: string; value: string | number | Date }): { defaultPanelDate: Date; parseValue: Date; selected: Date; setSelected: (value: A) => void }
  • merge from props used by SinglePicker

    Parameters

    • __namedParameters: { defaultDate: string | number | Date; format: string; value: string | number | Date }
      • defaultDate: string | number | Date
      • format: string
      • value: string | number | Date

    Returns { defaultPanelDate: Date; parseValue: Date; selected: Date; setSelected: (value: A) => void }

    • defaultPanelDate: Date
    • parseValue: Date
    • selected: Date
    • setSelected: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

useModelAndChildProps

useModelFromContext

  • useModelFromContext<Model>(ctx: IFormContext | null, name: string | undefined, model: Model | undefined, check: (m: any) => m is Model): Model | null

useModelObservable

  • useModelObservable<T, V>(model: IModel<T> | null, observable: (model: BasicModel<T>) => BehaviorSubject<V>): V

useModelValid

  • useModelValid<T>(model: IModel<T>): boolean | null

useModelValue

  • useModelValue<T>(model: IModel<T>): T | null

useMounted

  • useMounted(): MutableRefObject<boolean>

useMulti

  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, func4: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, func4: (t: T) => R, func5: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, func4: (t: T) => R, func5: (t: T) => R, func6: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, func4: (t: T) => R, func5: (t: T) => R, func6: (t: T) => R, func7: (t: T) => R, deps?: any[]): (t: T) => void
  • useMulti<T, R>(func1: (t: T) => R, func2: (t: T) => R, func3: (t: T) => R, func4: (t: T) => R, func5: (t: T) => R, func6: (t: T) => R, func7: (t: T) => R, func8: (t: T) => R, deps?: any[]): (t: T) => void
  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func4: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func4: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func5: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func4: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func5: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func6: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func4: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func5: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func6: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func7: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

  • Type parameters

    • T

    • R

    Parameters

    • func1: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func2: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func3: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func4: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func5: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func6: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func7: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • func8: (t: T) => R
        • (t: T): R
        • Parameters

          • t: T

          Returns R

    • Optional deps: any[]

    Returns (t: T) => void

      • (t: T): void
      • Parameters

        • t: T

        Returns void

useNamedChildModel

  • useNamedChildModel<T, K>(fieldSet: FieldSetModel<T>, name: K): T[K]

useNormalizeDisabledDate

  • useNormalizeDisabledDate(format: string, disabledDate: IDisabledDate): (date: Date) => boolean

usePanelDate

  • usePanelDate(defaultPanelDate: Date): { panelDate: Date; setPanelDate: (value: A) => void }
  • 获取面板默认位置日期

    Parameters

    • defaultPanelDate: Date

    Returns { panelDate: Date; setPanelDate: (value: A) => void }

    • panelDate: Date
    • setPanelDate: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

usePipe

  • usePipe<T0, T1, T2>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, deps?: any[]): (t0: T0) => T2
  • usePipe<T0, T1, T2, T3>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, deps?: any[]): (t0: T0) => T3
  • usePipe<T0, T1, T2, T3, T4>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, fn3: (t3: T3) => T4, deps?: any[]): (t0: T0) => T4
  • usePipe<T0, T1, T2, T3, T4, T5>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, fn3: (t3: T3) => T4, fn4: (t4: T4) => T5, deps?: any[]): (t0: T0) => T5
  • usePipe<T0, T1, T2, T3, T4, T5, T6>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, fn3: (t3: T3) => T4, fn4: (t4: T4) => T5, fn5: (t5: T5) => T6, deps?: any[]): (t0: T0) => T6
  • usePipe<T0, T1, T2, T3, T4, T5, T6, T7>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, fn3: (t3: T3) => T4, fn4: (t4: T4) => T5, fn5: (t5: T5) => T6, fn6: (t6: T6) => T7, deps?: any[]): (t0: T0) => T7
  • usePipe<T0, T1, T2, T3, T4, T5, T6, T7, T8>(fn0: (t0: T0) => T1, fn1: (t1: T1) => T2, fn2: (t2: T2) => T3, fn3: (t3: T3) => T4, fn4: (t4: T4) => T5, fn5: (t5: T5) => T6, fn6: (t6: T6) => T7, fn7: (t7: T7) => T8, deps?: any[]): (t0: T0) => T8
  • const callback = usePipe(foo, bar, baz)

    is equal to

    const callback = useMemo(() => arg => {
     return baz(bar(foo(arg)))
    }, [foo, bar, baz])

    Type parameters

    • T0

    • T1

    • T2

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • Optional deps: any[]

    Returns (t0: T0) => T2

      • (t0: T0): T2
      • Parameters

        • t0: T0

        Returns T2

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • Optional deps: any[]

    Returns (t0: T0) => T3

      • (t0: T0): T3
      • Parameters

        • t0: T0

        Returns T3

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • fn3: (t3: T3) => T4
        • (t3: T3): T4
        • Parameters

          • t3: T3

          Returns T4

    • Optional deps: any[]

    Returns (t0: T0) => T4

      • (t0: T0): T4
      • Parameters

        • t0: T0

        Returns T4

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • fn3: (t3: T3) => T4
        • (t3: T3): T4
        • Parameters

          • t3: T3

          Returns T4

    • fn4: (t4: T4) => T5
        • (t4: T4): T5
        • Parameters

          • t4: T4

          Returns T5

    • Optional deps: any[]

    Returns (t0: T0) => T5

      • (t0: T0): T5
      • Parameters

        • t0: T0

        Returns T5

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • fn3: (t3: T3) => T4
        • (t3: T3): T4
        • Parameters

          • t3: T3

          Returns T4

    • fn4: (t4: T4) => T5
        • (t4: T4): T5
        • Parameters

          • t4: T4

          Returns T5

    • fn5: (t5: T5) => T6
        • (t5: T5): T6
        • Parameters

          • t5: T5

          Returns T6

    • Optional deps: any[]

    Returns (t0: T0) => T6

      • (t0: T0): T6
      • Parameters

        • t0: T0

        Returns T6

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • fn3: (t3: T3) => T4
        • (t3: T3): T4
        • Parameters

          • t3: T3

          Returns T4

    • fn4: (t4: T4) => T5
        • (t4: T4): T5
        • Parameters

          • t4: T4

          Returns T5

    • fn5: (t5: T5) => T6
        • (t5: T5): T6
        • Parameters

          • t5: T5

          Returns T6

    • fn6: (t6: T6) => T7
        • (t6: T6): T7
        • Parameters

          • t6: T6

          Returns T7

    • Optional deps: any[]

    Returns (t0: T0) => T7

      • (t0: T0): T7
      • Parameters

        • t0: T0

        Returns T7

  • Type parameters

    • T0

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn0: (t0: T0) => T1
        • (t0: T0): T1
        • Parameters

          • t0: T0

          Returns T1

    • fn1: (t1: T1) => T2
        • (t1: T1): T2
        • Parameters

          • t1: T1

          Returns T2

    • fn2: (t2: T2) => T3
        • (t2: T2): T3
        • Parameters

          • t2: T2

          Returns T3

    • fn3: (t3: T3) => T4
        • (t3: T3): T4
        • Parameters

          • t3: T3

          Returns T4

    • fn4: (t4: T4) => T5
        • (t4: T4): T5
        • Parameters

          • t4: T4

          Returns T5

    • fn5: (t5: T5) => T6
        • (t5: T5): T6
        • Parameters

          • t5: T5

          Returns T6

    • fn6: (t6: T6) => T7
        • (t6: T6): T7
        • Parameters

          • t6: T6

          Returns T7

    • fn7: (t7: T7) => T8
        • (t7: T7): T8
        • Parameters

          • t7: T7

          Returns T8

    • Optional deps: any[]

    Returns (t0: T0) => T8

      • (t0: T0): T8
      • Parameters

        • t0: T0

        Returns T8

usePopover

usePopoverContext

useRadioHandler

useRangeDisabledDate

useRangeDisabledTime

  • useRangeDisabledTime(__namedParameters: { disabledTime: (date?: Date | null, type?: RangeType) => IDisabledTimeOption; selected: [Date, Date] }): { disabledConfirm: boolean; disabledEndTimes: (Anonymous function); disabledStartTimes: (Anonymous function) }

useRangeMergedProps

  • useRangeMergedProps(__namedParameters: { addMonthNum: number; defaultDate: [string | number | Date, string | number | Date]; format: string; value: [string | number | Date, string | number | Date] }): { defaultPanelDate: [Date, Date]; parseValue: [Date, Date]; selected: [Date, Date]; setDefaultPanelDate: (value: A) => void; setSelected: (value: A) => void }
  • Parameters

    • __namedParameters: { addMonthNum: number; defaultDate: [string | number | Date, string | number | Date]; format: string; value: [string | number | Date, string | number | Date] }
      • addMonthNum: number
      • defaultDate: [string | number | Date, string | number | Date]
      • format: string
      • value: [string | number | Date, string | number | Date]

    Returns { defaultPanelDate: [Date, Date]; parseValue: [Date, Date]; selected: [Date, Date]; setDefaultPanelDate: (value: A) => void; setSelected: (value: A) => void }

    • defaultPanelDate: [Date, Date]
    • parseValue: [Date, Date]
    • selected: [Date, Date]
    • setDefaultPanelDate: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

    • setSelected: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

Const useResizeObserver

  • useResizeObserver(callback: ResizeObserverCallback): { disconnect: (Anonymous function); observe: (Anonymous function); observer: MutableRefObject<ResizeObserver>; unobserve: (Anonymous function) }

Const useRunOnceInNextFrame

  • useRunOnceInNextFrame<T>(cb: T, disabled: boolean): T & Partial<ICancelable>

useShowTimeOption

useShowTimeRangeOption

useSinglePopoverVisible

  • useSinglePopoverVisible<DateType>(defaultSelected: DateType, setSelected: React.Dispatch<React.SetStateAction<DateType>>, onOpen: () => void, onClose: () => void, disabled?: boolean, openPanel?: boolean): { onVisibleChange: (Anonymous function); panelVisible: boolean; setPanelVisible: (value: A) => void }
  • Type parameters

    • DateType

    Parameters

    • defaultSelected: DateType
    • setSelected: React.Dispatch<React.SetStateAction<DateType>>
    • onOpen: () => void
        • (): void
        • Returns void

    • onClose: () => void
        • (): void
        • Returns void

    • Optional disabled: boolean
    • Optional openPanel: boolean

    Returns { onVisibleChange: (Anonymous function); panelVisible: boolean; setPanelVisible: (value: A) => void }

    • onVisibleChange: (Anonymous function)
    • panelVisible: boolean
    • setPanelVisible: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

useTimePanelValue

  • useTimePanelValue(selected: string, defaultTime: string, format: string): { panelTime: Date; setPanelTime: (value: A) => void }
  • 将字符串转成date类型,便于内部计算

    Parameters

    • selected: string
    • defaultTime: string
    • format: string

    Returns { panelTime: Date; setPanelTime: (value: A) => void }

    • panelTime: Date
    • setPanelTime: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

useTimeValue

  • useTimeValue<T>(defaultValue: T, value?: T): { selected: T; setSelected: (value: A) => void }
  • Type parameters

    • T

    Parameters

    • defaultValue: T
    • Optional value: T

    Returns { selected: T; setSelected: (value: A) => void }

    • selected: T
    • setSelected: (value: A) => void
        • (value: A): void
        • Parameters

          • value: A

          Returns void

useTransfer

useValue$

  • useValue$<T>(value$: Observable<T>, initialValue: T): T

useWeekRange

useWindowEventHandler

  • useWindowEventHandler<K>(eventName: K, listener: (ev: WindowEventMap[K]) => void, options?: AddEventListenerOptions): void
  • Type parameters

    • K: keyof WindowEventMap

    Parameters

    • eventName: K
    • listener: (ev: WindowEventMap[K]) => void
        • (ev: WindowEventMap[K]): void
        • Parameters

          • ev: WindowEventMap[K]

          Returns void

    • Optional options: AddEventListenerOptions

    Returns void

validate

  • validate<T>(model: BasicModel<T>): (Anonymous function)

warn

  • warn(text: any, duration?: number, callback?: () => void): number

Let warnValidStyle

  • warnValidStyle(): void

Let warning

  • warning(_shouldBeTrue: boolean, _format: string, ..._args: string[]): void

warningDefaultValueProp

  • warningDefaultValueProp(condition: boolean, propName: string, componentName: string): void

Let warningOnce

  • warningOnce(_shouldBeTrue: boolean, _id: string, _format: string, ..._args: string[]): void

warningSubscribeValid

  • warningSubscribeValid(shouldWarn: boolean, tag: FormWarningTag): void

warningSubscribeValue

  • warningSubscribeValue(shouldWarn: boolean, tag: FormWarningTag): void

weekFormatText

when

  • when<V>(condition: (ctx: ValidatorContext<V>) => boolean): (Anonymous function)

whenAsync

  • whenAsync<V>(condition: (formValue: ValidatorContext<V>) => Promise<boolean> | Observable<boolean>): (Anonymous function)

withDefaultOption

withErrorBoundary

withMessage

withinRange

  • withinRange(min: number, max: number, num: number): number

wrapPromise

  • wrapPromise(condition: boolean | Promise<any>): Promise<any>

Object literals

Const Cascader

Cascader: object

empty

empty: string = "Empty"

placeholder

placeholder: string = "Please select"

searchEmpty

searchEmpty: string = "No result"

searchPlaceholder

searchPlaceholder: string = "Please select or search"

title

title: string = "Title"

Const CopyButton

CopyButton<S, SS, S>: object

Type parameters

  • S

  • SS

  • S

constructor

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Readonly props

props: Readonly<ICopyButtonProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

copy

copy: string = "Copy"

error

error: string = "Copy failed"

success

success: string = "Copied"

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<ICopyButtonProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<ICopyButtonProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<ICopyButtonProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<ICopyButtonProps>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<ICopyButtonProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<ICopyButtonProps>, nextState: Readonly<S>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<ICopyButtonProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

onCopy

onCopyCallback

  • onCopyCallback(type: keyof typeof Notify, callback: string | (() => void)): void

render

  • render(): Element

setState

  • setState<K>(state: ((prevState: Readonly<S>, props: Readonly<ICopyButtonProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: ((prevState: Readonly<S>, props: Readonly<ICopyButtonProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ICopyButtonProps>, nextState: Readonly<S>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Static defaultProps

defaultProps: object

onCopyError

onCopyError: string = ""

onCopySuccess

onCopySuccess: string = ""

Const DEFAULT_DISABLED_POP_PROPS

DEFAULT_DISABLED_POP_PROPS: object

centerArrow

centerArrow: true = true

position

position: "top-right" = "top-right"

trigger

trigger: "hover" = "hover"

Const DEFAULT_RENDER_KEY

DEFAULT_RENDER_KEY: object

children

children: string = "children"

id

id: string = "id"

parentId

parentId: string = "parentId"

title

title: string = "title"

Const DEFAULT_STATE

DEFAULT_STATE: object

search

search: null = null

suggestionVisible

suggestionVisible: boolean = false

Const DEFAULT_WIDTH

DEFAULT_WIDTH: object = 19

CIRCLE

CIRCLE: number = 132

LINE

LINE: string = "100%"

Const DefaultCombinedDateRangeProps

DefaultCombinedDateRangeProps: object

format

format: string = DATE_FORMAT

Const DefaultDateRangeProps

DefaultDateRangeProps: object

format

format: string = DATE_FORMAT

Const DefaultMonthPickerProps

DefaultMonthPickerProps: object

format

format: string = MONTH_FORMAT

Const DefaultQuarterPickerProps

DefaultQuarterPickerProps: object

format

format: string = MONTH_FORMAT

Const DefaultState

DefaultState: object

activeIndex

activeIndex: number = 0

containerHeight

containerHeight: number = 0

items

items: undefined[] = []

preChildren

preChildren: null = null

renderItems

renderItems: undefined[] = []

transitionDuration

transitionDuration: number = 0

Const DefaultWeekPickerProps

DefaultWeekPickerProps: object

format

format: string = DATE_FORMAT

weekStartsOn

weekStartsOn: WeekStartsOnMap = WeekStartsOnMap.Monday

Const DefaultYearPickerProps

DefaultYearPickerProps: object

format

format: string = YEAR_FORMAT

Const Grid

Grid<Data, RowProps, SS>: object

Type parameters

  • Data

  • RowProps

  • SS

constructor

bodyTable

bodyTable: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

footEl

footEl: Element

footNode

footNode: RefObject<Footer> = createRef<Footer>()

gridNode

gridNode: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

handleBodyScrollRunOnceNextFrame

handleBodyScrollRunOnceNextFrame: (Anonymous function) & ICancelable = runOnceInNextFrame((e: React.UIEvent<HTMLDivElement>) => {if (!this.mounted) {return;}const target = e.target as HTMLDivElement;const { scroll = {}, autoStick } = this.props;const { scrollTop, scrollLeft } = target;const leftBody = this.leftBody?.current;const rightBody = this.rightBody?.current;const scrollHeader = this.scrollHeader?.current;const stickyHead = this.stickyHead?.current;const bodyTable = this.bodyTable?.current;if (this.lastScrollLeft !== target.scrollLeft && scroll.x) {if (scrollHeader && target === scrollHeader) {this.forceScroll(bodyTable, scrollLeft, 'Left');autoStick && this.forceScroll(stickyHead, scrollLeft, 'Left');}if (bodyTable && target === bodyTable) {this.forceScroll(scrollHeader, scrollLeft, 'Left');autoStick && this.forceScroll(stickyHead, scrollLeft, 'Left');}if (autoStick && target === stickyHead) {this.forceScroll(bodyTable, scrollLeft, 'Left');this.forceScroll(scrollHeader, scrollLeft, 'Left');}this.lastScrollLeft = scrollLeft;this.setScrollPositionClassName();}if (this.lastScrollTop !== target.scrollTop && scroll.y) {if (leftBody && target === leftBody) {this.forceScroll(rightBody, scrollTop, 'Top');this.forceScroll(bodyTable, scrollTop, 'Top');}if (rightBody && target === rightBody) {this.forceScroll(leftBody, scrollTop, 'Top');this.forceScroll(bodyTable, scrollTop, 'Top');}if (bodyTable && target === bodyTable) {this.forceScroll(rightBody, scrollTop, 'Top');this.forceScroll(leftBody, scrollTop, 'Top');}this.lastScrollTop = target.scrollTop;}})

headerEl

headerEl: Element

headerNode

headerNode: RefObject<Header<Data>> = createRef<Header<Data>>()

lastScrollLeft

lastScrollLeft: number

lastScrollTop

lastScrollTop: number

leftBody

leftBody: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

mounted

mounted: boolean = false

rightBody

rightBody: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

scrollBody

scrollBody: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

scrollHeader

scrollHeader: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

scrollPosition

scrollPosition: GridScrollPosition

selectionPropsCache

selectionPropsCache: {}

Type declaration

  • [key: string]: { disabled?: boolean; reason?: React.ReactNode }
    • Optional disabled?: boolean
    • Optional reason?: React.ReactNode

stickyHead

stickyHead: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

store

store: Store = new Store()

emptyLabel

emptyLabel: string = "No data"

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IGridProps<Data, RowProps>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IGridProps<Data, RowProps>>, nextState: Readonly<IGridState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: any): void

Optional componentWillMount

  • componentWillMount(): void

componentWillReceiveProps

  • componentWillReceiveProps(nextProps: IGridProps<Data, RowProps>): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IGridProps<Data, RowProps>>, nextState: Readonly<IGridState>, nextContext: any): void

forceScroll

  • forceScroll(target: EventTarget, distance: number, direction: "Left" | "Top"): void

getBatchComponents

  • getBatchComponents(position: "header" | "foot"): Element

getBatchFixedStyle

  • getBatchFixedStyle(): {} | { width: number }

getColumns

getDataKey

  • getDataKey(data: Data, rowIndex: number | string): any

getEmpty

getExpandBodyRender

  • getExpandBodyRender(expandRowKeys: boolean[]): (Anonymous function)

getExpandRowKeys

  • getExpandRowKeys(props: IGridProps<Data, RowProps>): boolean[]

getLeftColumns

  • getLeftColumns(): any

getLeftFixedTable

  • getLeftFixedTable(): Element[]

getRightColumns

  • getRightColumns(): any

getRightFixedTable

  • getRightFixedTable(): Element[]

getSelectionColumn

getSelectionPropsByItem

  • getSelectionPropsByItem(data: Data, rowIndex: number, nextSelection?: IGridSelection<Data>): { disabled?: boolean; reason?: React.ReactNode }
  • Parameters

    • data: Data
    • rowIndex: number
    • Optional nextSelection: IGridSelection<Data>

    Returns { disabled?: boolean; reason?: React.ReactNode }

    • Optional disabled?: boolean
    • Optional reason?: React.ReactNode

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IGridProps<Data, RowProps>>, prevState: Readonly<IGridState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getStickyHead

  • getStickyHead(): Element

getTable

  • getTable(options?: { bodyRef?: RefObject<HTMLDivElement>; columns?: Array<IGridInnerColumn<Data>>; fixed?: IGridInnerFixedType; headRef?: RefObject<HTMLDivElement>; isStickyHead?: boolean }): Element[]

handleBatchSelect

  • handleBatchSelect(type: "selectAll" | "removeAll", data: ReadonlyArray<Data>): void

handleBodyScroll

  • handleBodyScroll(e: UIEvent<HTMLDivElement>): void

handleExpandRow

  • handleExpandRow(clickRow: number, rowData: Data): (Anonymous function)

handleSelect

isAnyColumnsFixed

  • isAnyColumnsFixed(): any

isAnyColumnsLeftFixed

  • isAnyColumnsLeftFixed(): any

isAnyColumnsRightFixed

  • isAnyColumnsRightFixed(): any

onChange

onPaginationChange

  • onPaginationChange(pageSize: number, current: number): void

onResize

  • onResize(): void

onRowMouseEnter

  • onRowMouseEnter(mouseOverRowIndex: number): void

onScroll

  • onScroll(): void

onSelectChange

  • onSelectChange(selectedRowKeys: string[], data: Data | Data[]): void

render

  • render(): Element

renderSelectionCheckbox

  • renderSelectionCheckbox(): (Anonymous function)

renderSelectionRadio

  • renderSelectionRadio(): (Anonymous function)

setScrollPosition

setScrollPositionClassName

  • setScrollPositionClassName(): void

setStickyHeadWidth

  • setStickyHeadWidth(): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IGridProps<Data, RowProps>>, nextState: Readonly<IGridState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

syncFixedTableRowHeight

  • syncFixedTableRowHeight(): void

toggleBatchComponents

  • toggleBatchComponents(): void

Static defaultProps

defaultProps: object

autoStick

autoStick: false = false

autoStickOffsetTop

autoStickOffsetTop: number = 0

bordered

bordered: false = false

className

className: string = ""

columns

columns: undefined[] = []

datasets

datasets: undefined[] = []

disableHoverHighlight

disableHoverHighlight: false = false

ellipsis

ellipsis: false = false

emptyLabel

emptyLabel: string = ""

loading

loading: false = false

onChange

onChange: noop = noop

onExpand

onExpand: noop = noop

onRowClick

onRowClick: noop = noop

paginationType

paginationType: "default" = "default"

rowKey

rowKey: string = "id"

scroll

scroll: {}

Type declaration

stickyBatch

stickyBatch: false = false

Const HIDDEN_STYLE

HIDDEN_STYLE: object

opacity

opacity: number = 0

Const ICON_TYPE

ICON_TYPE: object

error

error: string = "close-circle"

info

info: string = "info-circle"

success

success: string = "check-circle"

warn

warn: string = "warning"

Const INVISIBLE_POSITION

INVISIBLE_POSITION: object

className

className: string = prefix('position-invisible')

style

style: object

left

left: number = -100000

opacity

opacity: number = 0

position

position: "fixed" = "fixed"

top

top: number = -100000

zIndex

zIndex: number = -10

Const MEASURE_STYLE

MEASURE_STYLE: object

height

height: string = "50px"

overflow

overflow: string = "scroll"

position

position: string = "absolute"

top

top: string = "-9999px"

width

width: string = "50px"

Const Mention

Mention<S, SS, S>: object

Type parameters

  • S

  • SS

  • S

constructor

BottomPosition

BottomPosition: IPositionFunction = getPopoverBottomPosition(this)

TopPosition

TopPosition: IPositionFunction = getPopoverTopPosition(this)

_compositing

_compositing: boolean

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

input

input: HTMLInputElement | HTMLTextAreaElement | null = null

onInputScroll

onInputScroll: (Anonymous function) & ICancelable = runOnceInNextFrame(() => {if (this.state.suggestionVisible) {this.setSuggestionVisible();}})

Readonly props

props: Readonly<IMentionProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

suggestionList

suggestionList: SelectMenu | null = null

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

noContent

noContent: string = "No result found, press SPACE to finish typing"

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IMentionProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IMentionProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: any): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IMentionProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IMentionProps>, nextState: Readonly<S>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

getCaretCoordinates

  • getCaretCoordinates(start: any): { height: number; left: number; top: number }

getDefaultState

  • getDefaultState(): {}

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IMentionProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

onCloseMenuList

  • onCloseMenuList(): void

onInputBlur

  • onInputBlur(evt: any): void

onInputChange

onInputCompositionEnd

  • onInputCompositionEnd(): void

onInputCompositionStart

  • onInputCompositionStart(): void

onInputKeyDown

  • onInputKeyDown(evt: any): void

onInputKeyUp

  • onInputKeyUp(evt: any): void

onSelectSuggestion

  • onSelectSuggestion(val: any): void

onSelectionChange

  • onSelectionChange(): void

onSuggestionListRefChange

  • onSuggestionListRefChange(instance: any): void

onSuggestionVisibleChange

  • onSuggestionVisibleChange(visible: any): void

render

  • render(): Element

saveInputRef

  • saveInputRef(instance: any): void

setState

  • setState<K>(state: ((prevState: Readonly<S>, props: Readonly<IMentionProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: ((prevState: Readonly<S>, props: Readonly<IMentionProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

setStateIfChange

  • setStateIfChange(state: any): void

setSuggestionVisible

  • setSuggestionVisible(value?: unknown): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IMentionProps>, nextState: Readonly<S>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IMentionProps>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

triggerEventCallback

  • triggerEventCallback(eventName: any, evt: any): void

state

state: object

placeholder

placeholder: null = null

position

position: undefined = undefined

Static defaultProps

defaultProps: object

inline

inline: boolean = true

multiLine

multiLine: boolean = false

position

position: string = "bottom"

suggestionNotFoundContent

suggestionNotFoundContent: string = ""

suggestions

suggestions: undefined[] = []

triggerText

triggerText: string = "@"

Const NOT_FOUND

NOT_FOUND: object

code

code: 1 = MENTION_NOT_FOUND

Const NO_BOTTOM_BORDER

NO_BOTTOM_BORDER: object

borderBottomColor

borderBottomColor: string = "rgba(255, 255, 255, 0)"

borderBottomWidth

borderBottomWidth: number = 0

transition

transition: string = `border-bottom-width 160ms ${EASE_IN_OUT}, border-bottom-color 160ms ${EASE_IN_OUT}`

Const NO_TRANSITION

NO_TRANSITION: object

MozTransition

MozTransition: string = "none"

OTransition

OTransition: string = "none"

WebkitTransition

WebkitTransition: string = "none"

msTransition

msTransition: string = "none"

transition

transition: string = "none"

Const Notify

Notify: object

clear

clear: clear

config

config: config

error

error: error

info

info: info

success

success: success

warn

warn: warn

Const OPTIONS

OPTIONS: object

passive

passive: boolean = true

Const PRESET_COLOR

PRESET_COLOR: object

blue

blue: boolean = true

green

green: boolean = true

grey

grey: boolean = true

red

red: boolean = true

yellow

yellow: boolean = true

Const Pagination

Pagination<S, SS>: object

Type parameters

  • S

  • SS

getLayout

getLayout: (Anonymous function) = memoize((props: IProps) => {return this.layoutFn(this.getLayoutOptions(props));})

items

items: string = " items"

selectWidth

selectWidth: number = 100

jumpTo

  • jumpTo(__namedParameters: { input: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { input: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • input: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

pageStats

  • pageStats(__namedParameters: { Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>; select: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>; select: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>
      • select: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

pageStatsStatic

  • pageStatsStatic(__namedParameters: { Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>; pageSize: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }): Element
  • Parameters

    • __namedParameters: { Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>; pageSize: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal }
      • Text: ComponentClass<{ type: "middle" | "right" }, any> | FunctionComponent<{ type: "middle" | "right" }>
      • pageSize: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • total: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal

    Returns Element

layoutFn

name

  • get name(): string

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IAbstractPaginationProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

getLayoutOptions

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getTotal

getTotalPages

  • getTotalPages(total: number, pageSize: number): number

onPageChange

  • onPageChange(page: number): void

onPageSizeChange

  • onPageSizeChange(pageSize: number): void

render

  • render(): Element

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IAbstractPaginationProps>, nextState: Readonly<S>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

shouldUpdateLayout

Static defaultProps

defaultProps: object

buttonBordered

buttonBordered: boolean = true

current

current: number = 1

pageSize

pageSize: number = 10

showQuickJumper

showQuickJumper: boolean = true

showSizeChanger

showSizeChanger: boolean = true

Const Placeholder

Placeholder: object

Circle

Circle: Circle

Rectangle

Rectangle: Rectangle

RichTextBlock

RichTextBlock: RichTextBlock

TextBlock

TextBlock: TextBlock

TextRow

TextRow: TextRow

TextRowDashed

TextRowDashed: TextRowDashed

Const Pop

Pop<SS>: object

Type parameters

  • SS

constructor

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Private isUnmounted

isUnmounted: boolean = false

Private popoverRef

popoverRef: RefObject<Popover> = createRef<Popover>()

Readonly props

props: Readonly<IPopProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Static withPop

withPop: expose = exposePopover('pop')

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IPopProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IPopProps>, nextState: Readonly<IPopState>, nextContext: any): void

adjustPosition

  • adjustPosition(): void

changePending

  • changePending(key: keyof IPopState, pending: boolean, callback?: () => void): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IPopProps>, prevState: Readonly<IPopState>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IPopProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IPopProps>, nextState: Readonly<IPopState>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IPopProps>, prevState: Readonly<IPopState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getWrappedPopover

render

  • render(): Element

renderTrigger

  • renderTrigger(): Element

setState

  • setState<K>(state: ((prevState: Readonly<IPopState>, props: Readonly<IPopProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    Parameters

    • state: ((prevState: Readonly<IPopState>, props: Readonly<IPopProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IPopProps>, nextState: Readonly<IPopState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

state

state: object

cancelPending

cancelPending: boolean = false

confirmPending

confirmPending: boolean = false

Static defaultProps

defaultProps: object

containerSelector

containerSelector: string = "body"

cushion

cushion: number = 10

mouseEnterDelay

mouseEnterDelay: number = 200

mouseLeaveDelay

mouseLeaveDelay: number = 200

position

position: string = "top-center"

trigger

trigger: string = "none"

type

type: string = "primary"

Const PreviewImage

PreviewImage: object

alt

alt: string = "Image download failed"

next

next: string = "Next"

prev

prev: string = "Previous"

rotate

rotate: string = "Rotate"

Const RESIZE_OPTIONS

RESIZE_OPTIONS: object

passive

passive: boolean = true

Const RangePicker

30

30: string = "30 days"

7

7: string = "7 days"

Const Select

Select<Key, Item, SS>: object

Type parameters

constructor

context

filterOptions

filterOptions: (Anonymous function) = memoize((keyword: string,options: Item[] = [],filter: ((keyword: string, item: Item) => boolean) | false,creatable: boolean,isValidNewOption: (keyword: string, options: Item[]) => boolean): Item[] => {const filtered =filter !== false && keyword? options.filter(it => filter?.(keyword, it)): options;const pendingCreateOption =creatable && keyword && isValidNewOption?.(keyword, options)? [{key: SELECT_CREATABLE_KEY,text: keyword,},]: [];return (pendingCreateOption as Item[]).concat(filtered);})

inputRef

inputRef: RefObject<HTMLInputElement> = createRef<HTMLInputElement>()

popoverRef

popoverRef: RefObject<Popover> = createRef<Popover>()

Readonly props

props: Readonly<ISelectProps<Key, Item>> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<ISelectState<Key, Item>>

triggerRef

triggerRef: RefObject<HTMLDivElement> = createRef<HTMLDivElement>()

Static contextType

contextType: Context<IDisabledContext> = DisabledContext

Static reviveValue

reviveValue: reviveSelectItem = reviveSelectItem

create

create: string = "+Create: "

empty

empty: string = "Not Found"

input

input: string = "Please choose..."

tagSeparator

tagSeparator: string = ", "

disabled

  • get disabled(): boolean

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<ISelectProps<Key, Item>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: ISelectProps<Key, Item>): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<ISelectProps<Key, Item>>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): void

focusSearchInput

  • focusSearchInput(): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

getSearchPlaceholder

  • getSearchPlaceholder(): string

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<ISelectProps<Key, Item>>, prevState: Readonly<ISelectState<Key, Item>>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

globalClick

  • globalClick(e: MouseEvent): void

onClear

  • onClear(e: MouseEvent): void

onCreateClick

  • onCreateClick(): void

onIndexChange

  • onIndexChange(delta: 1 | -1): void

onKeywordChange

  • onKeywordChange(e: ChangeEvent<HTMLInputElement>): void

onOptionMouseEnter

  • onOptionMouseEnter(index: number): void

onOptionMouseLeave

  • onOptionMouseLeave(index: number): void

onRemove

  • onRemove(item: Item): void

onSelect

  • onSelect(item: Item): void

onVisibleChange

  • onVisibleChange(open: boolean): void

render

  • render(): Element

renderOption

  • renderOption(option: Item, index: number): Element

renderPopoverContent

renderTagCollapsedTrigger

  • renderTagCollapsedTrigger(value: Item[]): Element

renderTagList

renderValue

resetKeyword

  • resetKeyword(source: ISelectKeywordChangeMeta["source"]): void

selectCurrentIndex

  • selectCurrentIndex(): void

setKeyword

  • setKeyword(keyword: string, source: ISelectKeywordChangeMeta["source"]): void

setState

  • setState<K>(state: ((prevState: Readonly<ISelectState<Key, Item>>, props: Readonly<ISelectProps<Key, Item>>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    Parameters

    • state: ((prevState: Readonly<ISelectState<Key, Item>>, props: Readonly<ISelectProps<Key, Item>>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

tryReviveOption

Static getDerivedStateFromProps

Static defaultProps

defaultProps: object

clearable

clearable: boolean = false

creatable

creatable: boolean = false

filter

filter: defaultFilter = defaultFilter

highlight

highlight: defaultHighlight = defaultHighlight

isEqual

isEqual: defaultIsEqual = defaultIsEqual

isValidNewOption

isValidNewOption: defaultIsValidNewOption = defaultIsValidNewOption

loading

loading: boolean = false

multiple

multiple: boolean = false

renderOptionList

renderOptionList: defaultRenderOptionList = defaultRenderOptionList

width

width: number = 240

Const SinglePanelMap

SinglePanelMap: object

date

date: FunctionComponent<IDatePickerPanelProps> = DatePanel

month

month: FunctionComponent<ISinglePanelProps> = MonthPanel

quarter

quarter: FunctionComponent<{}> = QuarterPanel

week

week: FunctionComponent<ISinglePanelProps & {}> = WeekPanel

year

year: FunctionComponent<{}> = YearPanel

Const StyleMap

StyleMap: object

bottom

bottom: object

bottom

bottom: number = 0

left

left: number = 0

width

width: string = "100%"

left

left: object

height

height: string = "100%"

left

left: number = 0

top

top: number = 0

right

right: object

height

height: string = "100%"

right

right: number = 0

top

top: number = 0

top

top: object

left

left: number = 0

top

top: number = 0

width

width: string = "100%"

Const Sweetalert

Sweetalert: object

IAlertOption

IAlertOption:

Optional className

className: string

Optional closeBtn

closeBtn: boolean

Optional confirmText

confirmText: string

Optional confirmType

confirmType: "default" | "primary" | "danger" | "success"

Optional content

content: React.ReactNode

Optional maskClosable

maskClosable: boolean

Optional onCancel

Optional onClose

onClose: () => void

Type declaration

    • (): void
    • Returns void

Optional onConfirm

Optional parentComponent

parentComponent: any

Optional title

title: React.ReactNode

Optional type

type: "info" | "success" | "error" | "warning"

IConfirmOption

IConfirmOption:

Optional cancelText

cancelText: React.ReactNode

Optional className

className: string

Optional closeBtn

closeBtn: boolean

Optional confirmText

confirmText: string

Optional confirmType

confirmType: "default" | "primary" | "danger" | "success"

Optional content

content: React.ReactNode

Optional maskClosable

maskClosable: boolean

Optional onCancel

Optional onClose

onClose: () => void

Type declaration

    • (): void
    • Returns void

Optional onConfirm

Optional parentComponent

parentComponent: any

Optional title

title: React.ReactNode

Optional type

type: "info" | "success" | "error" | "warning"

alert

alert: alert

confirm

confirm: confirm

info

info: alert

title

title: string = "Alert"

Const Switch

Switch<S, SS, S>: object

Type parameters

  • S

  • SS

  • S

constructor

context

Readonly props

props: Readonly<ISwitchProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static contextType

contextType: Context<IDisabledContext> = DisabledContext

checked

checked: string = "On"

unchecked

unchecked: string = "Off"

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<ISwitchProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<ISwitchProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<ISwitchProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<ISwitchProps>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<ISwitchProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<ISwitchProps>, nextState: Readonly<S>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<ISwitchProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

render

  • render(): Element

setState

  • setState<K>(state: ((prevState: Readonly<S>, props: Readonly<ISwitchProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: ((prevState: Readonly<S>, props: Readonly<ISwitchProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ISwitchProps>, nextState: Readonly<S>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<ISwitchProps>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

toggle

  • toggle(): void

Static defaultProps

defaultProps: object

size

size: string = "default"

Const TabsNavComponents

TabsNavComponents: object

button

button: ButtonTabsNav = ButtonTabsNav

card

card: CardTabsNav = CardTabsNav

normal

normal: NormalTabsNav = NormalTabsNav

Const Transfer

emptyLabel

emptyLabel: string = "No Data"

item

item: string = "item"

items

items: string = "items"

placeholder

placeholder: string = "Please Enter"

Const UNIT_MAP

UNIT_MAP: object

hour

hour: number = 23

minute

minute: number = 59

second

second: number = 59

Const Upload

Upload<SS>: object

Type parameters

  • SS

constructor

Static FILE_UPLOAD_STATUS

FILE_UPLOAD_STATUS: FILE_UPLOAD_STATUS = FILE_UPLOAD_STATUS

add

add: string = "Add File"

delete

delete: string = "Delete"

failed

failed: string = "Failed"

limit

limit: string = "Maximum number of files has been reached"

retry

retry: string = "Retry"

uploading

uploading: string = "File uploading"

fileList

  • get fileList(): P["fileList"] | (UPLOAD_ITEM & { _file?: File; _id?: string })[]

isControlled

  • get isControlled(): boolean

remainAmount

  • get remainAmount(): number

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IUploadProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IUploadProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

Protected createNewUploadFileItem

deleteUploadItem

emitOnError

  • emitOnError(type: Type, data: IUploadErrorMessageConfigMap[Type]): void

emitOnUpload

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getUploadItem

Protected getUploadSuccessOverrideProps

onTriggerUploadFile

  • onTriggerUploadFile(file: File): Promise<void>

render

  • render(): Element

Protected renderTips

  • renderTips(): Element

Protected renderTrigger

Protected renderUploadList

retryUploadItem

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

updateFileList

updateUploadItem

updateUploadItemPercent

  • updateUploadItemPercent(updateItemId: string, percent: number): void

updateUploadItemStatusToFailed

  • updateUploadItemStatusToFailed(updateItemId: string): void

updateUploadItemStatusToSuccess

  • updateUploadItemStatusToSuccess(updateItemId: string, onUploadSuccessReturn: void): void

Static getDerivedStateFromProps

Static defaultProps

defaultProps: object

manualUpload

manualUpload: false = false

maxAmount

maxAmount: number = DEFAULT_MAX_AMOUNT

maxSize

maxSize: number = DEFAULT_MAX_SIZE

multiple

multiple: false = DEFAULT_ENABLE_MULTIPLE

pageSize

pageSize: number = 5

pagination

pagination: false = false

sortable

sortable: false = false

Const WORDBREAK_STYLES

WORDBREAK_STYLES: object

overflowWrap

overflowWrap: "break-word" = "break-word"

wordBreak

wordBreak: "break-all" = "break-all"

Const classNames

classNames: object

appear

appear: string = "zent-notice-animation-enter"

appearActive

appearActive: string = "zent-notice-animation-enter-active"

appearDone

appearDone: string = "zent-notice-animation-enter-done"

enter

enter: string = "zent-notice-animation-enter"

enterActive

enterActive: string = "zent-notice-animation-enter-active"

enterDone

enterDone: string = "zent-notice-animation-enter-done"

exit

exit: string = "zent-notice-animation-exit"

exitActive

exitActive: string = "zent-notice-animation-exit-active"

exitDone

exitDone: string = "zent-notice-animation-exit-done"

Const common

common: object

cancel

cancel: string = "Cancel"

comma

comma: string = ", "

confirm

confirm: string = "Confirm"

ok

ok: string = "OK"

reset

reset: string = "Reset"

Const containers

containers: object

left-bottom

left-bottom: null = null

left-top

left-top: null = null

right-bottom

right-bottom: null = null

right-top

right-top: null = null

Const dateConfig

dateConfig: object

date

date: object

endDate

endDate: endOfDay = endOfDay

get

get: getDate = getDate

isSame

isSame: isSameDay = isSameDay

offsetDate

offsetDate: addDays = addDays

set

set: setDate = setDate

startDate

startDate: startOfDay = startOfDay

month

month: object

endDate

endDate: endOfMonth = endOfMonth

get

get: getMonth = getMonth

offsetDate

offsetDate: addMonths = addMonths

set

set: setMonth = setMonth

startDate

startDate: startOfMonth = startOfMonth

isSame

  • isSame(dateLeft: Date, dateRight: Date): boolean

quarter

quarter: object

endDate

endDate: endOfQuarter = endOfQuarter

get

get: getQuarter = getQuarter

offsetDate

offsetDate: addQuarters = addQuarters

set

set: setQuarter = setQuarter

startDate

startDate: startOfQuarter = startOfQuarter

isSame

  • isSame(dateLeft: Date, dateRight: Date): boolean

week

week: object

endDate

endDate: endOfWeek = endOfWeek

get

get: getWeek = getWeek

isSame

isSame: isSameWeek = isSameWeek

offsetDate

offsetDate: addDays = addDays

set

set: setWeek = setWeek

startDate

startDate: startOfWeek = startOfWeek

year

year: object

endDate

endDate: endOfYear = endOfYear

get

get: getYear = getYear

isSame

isSame: isSameYear = isSameYear

offsetDate

offsetDate: addYears = addYears

set

set: setYear = setYear

startDate

startDate: startOfYear = startOfYear

Const defaultDatePickerCommonProps

defaultDatePickerCommonProps: object

canClear

canClear: boolean = true

onChange

onChange: noop = noop

onClose

onClose: noop = noop

onOpen

onOpen: noop = noop

valueType

valueType: "string" | "number" | "date" = 'string' as IValueType

disabledDate

  • disabledDate(): boolean

Const defaultDatePickerProps

defaultDatePickerProps: object

format

format: string = DATE_FORMAT

Const defaultOption

defaultOption: object

getEventValue

  • getEventValue(e: any): any

Const defaultPageInfo

defaultPageInfo: object

current

current: number = 1

pageSize

pageSize: number = 10

Const defaultTimePickerProps

defaultTimePickerProps: object

canClear

canClear: boolean = true

format

format: string = TIME_FORMAT

hourStep

hourStep: number = 1

minuteStep

minuteStep: number = 1

secondStep

secondStep: number = 1

Const enUS

enUS: object

amPm

amPm: [string, string] = ['am', 'pm']

dayNames

dayNames: [string, string, string, string, string, string, string] = ['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday',]

dayNamesShort

dayNamesShort: [string, string, string, string, string, string, string] = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']

monthNames

monthNames: [string, string, string, string, string, string, string, string, string, string, string, string] = ['January','February','March','April','May','June','July','August','September','October','November','December',]

monthNamesShort

monthNamesShort: [string, string, string, string, string, string, string, string, string, string, string, string] = ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec',]

DoFn

  • DoFn(D: number): string

Const formatFlags

formatFlags: object

A

D

  • D(dateObj: Date): string

DD

  • DD(dateObj: Date): string

Do

H

  • H(dateObj: Date): string

HH

  • HH(dateObj: Date): string

M

  • M(dateObj: Date): string

MM

  • MM(dateObj: Date): string

MMM

MMMM

S

  • S(dateObj: Date): string

SS

  • SS(dateObj: Date): string

SSS

  • SSS(dateObj: Date): string

YY

  • YY(dateObj: Date): string

YYYY

  • YYYY(dateObj: Date): string

ZZ

  • ZZ(dateObj: Date): string

a

d

  • d(dateObj: Date): string

dd

  • dd(dateObj: Date): string

ddd

dddd

h

  • h(dateObj: Date): string

hh

  • hh(dateObj: Date): string

m

  • m(dateObj: Date): string

mm

  • mm(dateObj: Date): string

s

  • s(dateObj: Date): string

ss

  • ss(dateObj: Date): string

Const i18n

i18n: object

amPm

amPm: [string, string] = ['am', 'pm']

dayNames

dayNames: [string, string, string, string, string, string, string]

dayNamesShort

dayNamesShort: [string, string, string, string, string, string, string]

monthNames

monthNames: [string, string, string, string, string, string, string, string, string, string, string, string]

monthNamesShort

monthNamesShort: [string, string, string, string, string, string, string, string, string, string, string, string]

DoFn

  • DoFn(D: number): string

Const iconTypeMap

iconTypeMap: object

error

error: "error-circle" = "error-circle"

info

info: "info-circle" = "info-circle"

success

success: "check-circle" = "check-circle"

warning

warning: "warning" = "warning"

Const initialState

initialState: object

submitFailed

submitFailed: false = false

submitSucceeded

submitSucceeded: false = false

submitting

submitting: false = false

Const isUnitlessNumber

isUnitlessNumber: object

CSS properties which accept numbers but are not in units of "px".

animationIterationCount

animationIterationCount: true = true

borderImageOutset

borderImageOutset: true = true

borderImageSlice

borderImageSlice: true = true

borderImageWidth

borderImageWidth: true = true

boxFlex

boxFlex: true = true

boxFlexGroup

boxFlexGroup: true = true

boxOrdinalGroup

boxOrdinalGroup: true = true

columnCount

columnCount: true = true

columns

columns: true = true

fillOpacity

fillOpacity: true = true

flex

flex: true = true

flexGrow

flexGrow: true = true

flexNegative

flexNegative: true = true

flexOrder

flexOrder: true = true

flexPositive

flexPositive: true = true

flexShrink

flexShrink: true = true

floodOpacity

floodOpacity: true = true

fontWeight

fontWeight: true = true

gridArea

gridArea: true = true

gridColumn

gridColumn: true = true

gridColumnEnd

gridColumnEnd: true = true

gridColumnSpan

gridColumnSpan: true = true

gridColumnStart

gridColumnStart: true = true

gridRow

gridRow: true = true

gridRowEnd

gridRowEnd: true = true

gridRowSpan

gridRowSpan: true = true

gridRowStart

gridRowStart: true = true

lineClamp

lineClamp: true = true

lineHeight

lineHeight: true = true

opacity

opacity: true = true

order

order: true = true

orphans

orphans: true = true

stopOpacity

stopOpacity: true = true

strokeDasharray

strokeDasharray: true = true

strokeDashoffset

strokeDashoffset: true = true

strokeMiterlimit

strokeMiterlimit: true = true

strokeOpacity

strokeOpacity: true = true

strokeWidth

strokeWidth: true = true

tabSize

tabSize: true = true

widows

widows: true = true

zIndex

zIndex: true = true

zoom

zoom: true = true

Const masks

masks: object

default

default: string = "ddd MMM DD YYYY HH:mm:ss"

fullDate

fullDate: string = "dddd, MMMM D, YYYY"

longDate

longDate: string = "MMMM D, YYYY"

longTime

longTime: string = "HH:mm:ss.SSS"

mediumDate

mediumDate: string = "MMM D, YYYY"

mediumTime

mediumTime: string = "HH:mm:ss"

shortDate

shortDate: string = "M/D/YY"

shortTime

shortTime: string = "HH:mm"

Const matchers

matchers: object

CSS_UNIT

CSS_UNIT: RegExp = new RegExp(CSS_UNIT)

hex3

hex3: RegExp = /^#?([0-9a-fA-F]{1})([0-9a-fA-F]{1})([0-9a-fA-F]{1})$/

hex4

hex4: RegExp = /^#?([0-9a-fA-F]{1})([0-9a-fA-F]{1})([0-9a-fA-F]{1})([0-9a-fA-F]{1})$/

hex6

hex6: RegExp = /^#?([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})$/

hex8

hex8: RegExp = /^#?([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})$/

hsl

hsl: RegExp = new RegExp('hsl' + PERMISSIVE_MATCH3)

hsla

hsla: RegExp = new RegExp('hsla' + PERMISSIVE_MATCH4)

hsv

hsv: RegExp = new RegExp('hsv' + PERMISSIVE_MATCH3)

hsva

hsva: RegExp = new RegExp('hsva' + PERMISSIVE_MATCH4)

rgb

rgb: RegExp = new RegExp('rgb' + PERMISSIVE_MATCH3)

rgba

rgba: RegExp = new RegExp('rgba' + PERMISSIVE_MATCH4)

Const mimeTypeIconMap

mimeTypeIconMap: object

获取状态展示图标

audio

audio: Element = (<IconclassName="zent-file-upload-item-icon zent-file-upload-item-icon__type"type="voice"/>)

video

video: Element = (<IconclassName="zent-file-upload-item-icon zent-file-upload-item-icon__type"type="video"/>)

Const parseFlags

parseFlags: object

A

A: [string, setPm] = [word, setPm]

D

D: [string, setDay] = [twoDigits, setDay]

DD

DD: [string, setDay] = [twoDigits, setDay]

Do

Do: [string, setDay] = [twoDigits + word, setDay]

H

H: [string, setHour] = [twoDigits, setHour]

HH

HH: [string, setHour] = [twoDigits, setHour]

M

M: [string, setMonth] = [twoDigits, setMonth]

MM

MM: [string, setMonth] = [twoDigits, setMonth]

MMM

MMM: [string, (Anonymous function)] = [word, monthUpdate('monthNamesShort')]

MMMM

MMMM: [string, (Anonymous function)] = [word, monthUpdate('monthNames')]

S

S: [string, (Anonymous function)] = ['\\d',(d, v) => {d.millisecond = parseInt(v, 10) * 100;},]

SS

SS: [string, (Anonymous function)] = ['\\d{2}',(d, v) => {d.millisecond = parseInt(v, 10) * 10;},]

SSS

SSS: [string, (Anonymous function)] = [threeDigits,(d, v) => {d.millisecond = parseInt(v, 10);},]

YY

YY: [string, (Anonymous function)] = [twoDigits,(d, v: string) => {const y = parseInt(v, 10);const da = new Date();const cent = parseInt(String(da.getFullYear()).substr(0, 2), 10);const year = String(y > 68 ? cent - 1 : cent) + v;d.year = parseInt(year, 10);},]

YYYY

YYYY: [string, (Anonymous function)] = [fourDigits,(d, v) => {d.year = parseInt(v, 10);},]

ZZ

ZZ: [string, (Anonymous function)] = ['[^\\s]*?[\\+\\-]\\d\\d:?\\d\\d|[^\\s]*?Z',(d, v) => {const parts = (v + '').match(/([+-]|\d\d)/gi);let minutes: number;if (parts) {minutes = parseInt(parts[1], 10) * 60 + parseInt(parts[2], 10);d.timezoneOffset = parts[0] === '+' ? minutes : -minutes;}},]

a

a: [string, setPm] = [word, setPm]

d

d: [string, noop] = [twoDigits, noop]

dd

dd: [string, noop] = [twoDigits, noop]

ddd

ddd: [string, noop] = [word, noop]

dddd

dddd: [string, noop] = [word, noop]

h

h: [string, setHour] = [twoDigits, setHour]

hh

hh: [string, setHour] = [twoDigits, setHour]

m

m: [string, setMinute] = [twoDigits, setMinute]

mm

mm: [string, setMinute] = [twoDigits, setMinute]

s

s: [string, setSecond] = [twoDigits, setSecond]

ss

ss: [string, setSecond] = [twoDigits, setSecond]

Const positionMap

positionMap: object

BottomCenter

BottomCenter: IPositionFunction

BottomLeft

BottomLeft: IPositionFunction

BottomLeftInViewport

BottomLeftInViewport: IPositionFunction

BottomRight

BottomRight: IPositionFunction

TopCenter

TopLeft

TopLeftInViewport

TopLeftInViewport: IPositionFunction

TopRight

Const red

red: object

hex

hex: string = "#ff0000"

hsl

hsl: object

a

a: number = 1

h

h: number = 0

l

l: number = 0.5

s

s: number = 1

hsv

hsv: object

a

a: number = 1

h

h: number = 0

s

s: number = 1

v

v: number = 1

rgb

rgb: object

a

a: number = 1

b

b: number = 0

g

g: number = 0

r

r: number = 255

Const scrollbarMeasure

scrollbarMeasure: object

height

height: string = "50px"

overflow

overflow: string = "scroll"

position

position: string = "absolute"

top

top: string = "-9999px"

width

width: string = "50px"

Const setTimeMap

setTimeMap: object

hour

hour: setHours = setHours

minute

minute: setMinutes = setMinutes

second

second: setSeconds = setSeconds

Const shorthandToLonghand

shorthandToLonghand: object

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

animation

animation: string[] = ['animationDelay','animationDirection','animationDuration','animationFillMode','animationIterationCount','animationName','animationPlayState','animationTimingFunction',]

background

background: string[] = ['backgroundAttachment','backgroundClip','backgroundColor','backgroundImage','backgroundOrigin','backgroundPositionX','backgroundPositionY','backgroundRepeat','backgroundSize',]

backgroundPosition

backgroundPosition: string[] = ['backgroundPositionX', 'backgroundPositionY']

border

border: string[] = ['borderBottomColor','borderBottomStyle','borderBottomWidth','borderImageOutset','borderImageRepeat','borderImageSlice','borderImageSource','borderImageWidth','borderLeftColor','borderLeftStyle','borderLeftWidth','borderRightColor','borderRightStyle','borderRightWidth','borderTopColor','borderTopStyle','borderTopWidth',]

borderBlockEnd

borderBlockEnd: string[] = ['borderBlockEndColor','borderBlockEndStyle','borderBlockEndWidth',]

borderBlockStart

borderBlockStart: string[] = ['borderBlockStartColor','borderBlockStartStyle','borderBlockStartWidth',]

borderBottom

borderBottom: string[] = ['borderBottomColor', 'borderBottomStyle', 'borderBottomWidth']

borderColor

borderColor: string[] = ['borderBottomColor','borderLeftColor','borderRightColor','borderTopColor',]

borderImage

borderImage: string[] = ['borderImageOutset','borderImageRepeat','borderImageSlice','borderImageSource','borderImageWidth',]

borderInlineEnd

borderInlineEnd: string[] = ['borderInlineEndColor','borderInlineEndStyle','borderInlineEndWidth',]

borderInlineStart

borderInlineStart: string[] = ['borderInlineStartColor','borderInlineStartStyle','borderInlineStartWidth',]

borderLeft

borderLeft: string[] = ['borderLeftColor', 'borderLeftStyle', 'borderLeftWidth']

borderRadius

borderRadius: string[] = ['borderBottomLeftRadius','borderBottomRightRadius','borderTopLeftRadius','borderTopRightRadius',]

borderRight

borderRight: string[] = ['borderRightColor', 'borderRightStyle', 'borderRightWidth']

borderStyle

borderStyle: string[] = ['borderBottomStyle','borderLeftStyle','borderRightStyle','borderTopStyle',]

borderTop

borderTop: string[] = ['borderTopColor', 'borderTopStyle', 'borderTopWidth']

borderWidth

borderWidth: string[] = ['borderBottomWidth','borderLeftWidth','borderRightWidth','borderTopWidth',]

columnRule

columnRule: string[] = ['columnRuleColor', 'columnRuleStyle', 'columnRuleWidth']

columns

columns: string[] = ['columnCount', 'columnWidth']

flex

flex: string[] = ['flexBasis', 'flexGrow', 'flexShrink']

flexFlow

flexFlow: string[] = ['flexDirection', 'flexWrap']

font

font: string[] = ['fontFamily','fontFeatureSettings','fontKerning','fontLanguageOverride','fontSize','fontSizeAdjust','fontStretch','fontStyle','fontVariant','fontVariantAlternates','fontVariantCaps','fontVariantEastAsian','fontVariantLigatures','fontVariantNumeric','fontVariantPosition','fontWeight','lineHeight',]

fontVariant

fontVariant: string[] = ['fontVariantAlternates','fontVariantCaps','fontVariantEastAsian','fontVariantLigatures','fontVariantNumeric','fontVariantPosition',]

gap

gap: string[] = ['columnGap', 'rowGap']

grid

grid: string[] = ['gridAutoColumns','gridAutoFlow','gridAutoRows','gridTemplateAreas','gridTemplateColumns','gridTemplateRows',]

gridArea

gridArea: string[] = ['gridColumnEnd', 'gridColumnStart', 'gridRowEnd', 'gridRowStart']

gridColumn

gridColumn: string[] = ['gridColumnEnd', 'gridColumnStart']

gridColumnGap

gridColumnGap: string[] = ['columnGap']

gridGap

gridGap: string[] = ['columnGap', 'rowGap']

gridRow

gridRow: string[] = ['gridRowEnd', 'gridRowStart']

gridRowGap

gridRowGap: string[] = ['rowGap']

gridTemplate

gridTemplate: string[] = ['gridTemplateAreas','gridTemplateColumns','gridTemplateRows',]

listStyle

listStyle: string[] = ['listStyleImage', 'listStylePosition', 'listStyleType']

margin

margin: string[] = ['marginBottom', 'marginLeft', 'marginRight', 'marginTop']

marker

marker: string[] = ['markerEnd', 'markerMid', 'markerStart']

mask

mask: string[] = ['maskClip','maskComposite','maskImage','maskMode','maskOrigin','maskPositionX','maskPositionY','maskRepeat','maskSize',]

maskPosition

maskPosition: string[] = ['maskPositionX', 'maskPositionY']

outline

outline: string[] = ['outlineColor', 'outlineStyle', 'outlineWidth']

overflow

overflow: string[] = ['overflowX', 'overflowY']

padding

padding: string[] = ['paddingBottom', 'paddingLeft', 'paddingRight', 'paddingTop']

placeContent

placeContent: string[] = ['alignContent', 'justifyContent']

placeItems

placeItems: string[] = ['alignItems', 'justifyItems']

placeSelf

placeSelf: string[] = ['alignSelf', 'justifySelf']

textDecoration

textDecoration: string[] = ['textDecorationColor','textDecorationLine','textDecorationStyle',]

textEmphasis

textEmphasis: string[] = ['textEmphasisColor', 'textEmphasisStyle']

transition

transition: string[] = ['transitionDelay','transitionDuration','transitionProperty','transitionTimingFunction',]

wordWrap

wordWrap: string[] = ['overflowWrap']

Const stackTraceStyle

stackTraceStyle: object

whiteSpace

whiteSpace: "pre" = "pre"

Const transformMap

transformMap: object

left

left: string = ""

right

right: string = "matrix(-1 0 0 1 18 0)"

Const transforms

transforms: object

absolute

  • absolute(value: any): { bottom: any; left: any; position: string; right: any; top: any }

borderRadius

  • borderRadius(value: any): { MozBorderRadius: any; OBorderRadius: any; WebkitBorderRadius: any; borderRadius: any; msBorderRadius: any }
  • Parameters

    • value: any

    Returns { MozBorderRadius: any; OBorderRadius: any; WebkitBorderRadius: any; borderRadius: any; msBorderRadius: any }

    • MozBorderRadius: any
    • OBorderRadius: any
    • WebkitBorderRadius: any
    • borderRadius: any
    • msBorderRadius: any

boxShadow

  • boxShadow(value: any): { MozBoxShadow: any; OBoxShadow: any; WebkitBoxShadow: any; boxShadow: any; msBoxShadow: any }

flex

  • flex(value: any): { MozBoxFlex: any; WebkitBoxFlex: any; WebkitFlex: any; flex: any; msFlex: any }

flexBasis

  • flexBasis(value: any): { WebkitFlexBasis: any; flexBasis: any }

justifyContent

  • justifyContent(value: any): { WebkitJustifyContent: any; justifyContent: any }

transform

  • transform(value: any): { MozTransform: any; OTransform: any; WebkitTransform: any; msTransform: any; transform: any }

transition

  • transition(value: any): { MozTransition: any; OTransition: any; WebkitTransition: any; msTransition: any; transition: any }

userSelect

  • userSelect(value: any): { KhtmlUserSelect: any; MozUserSelect: any; WebkitTouchCallout: any; WebkitUserSelect: any; msUserSelect: any; userSelect: any }
  • Parameters

    • value: any

    Returns { KhtmlUserSelect: any; MozUserSelect: any; WebkitTouchCallout: any; WebkitUserSelect: any; msUserSelect: any; userSelect: any }

    • KhtmlUserSelect: any
    • MozUserSelect: any
    • WebkitTouchCallout: any
    • WebkitUserSelect: any
    • msUserSelect: any
    • userSelect: any

Const zhCN

zhCN: object

amPm

amPm: [string, string] = ['上午', '下午']

dayNames

dayNames: [string, string, string, string, string, string, string] = ['星期日','星期一','星期二','星期三','星期四','星期五','星期六',]

dayNamesShort

dayNamesShort: [string, string, string, string, string, string, string] = ['周日', '周一', '周二', '周三', '周四', '周五', '周六']

monthNames

monthNames: [string, string, string, string, string, string, string, string, string, string, string, string] = ['一月','二月','三月','四月','五月','六月','七月','八月','九月','十月','十一月','十二月',]

monthNamesShort

monthNamesShort: [string, string, string, string, string, string, string, string, string, string, string, string] = ['1月','2月','3月','4月','5月','6月','7月','8月','9月','10月','11月','12月',]

DoFn

  • DoFn(D: number): string

Generated using TypeDoc